基于资源的权限系统-API设计

概述

权限系统需要和别的系统集成，因此，良好的API是易用性的保证。

这里只设计一些权限相关的核心 API，关于用户，组织，导入导出之类的后续再逐步补充

API 设计

围绕权限有以下 4 类 API:

授权

1. 单独授权 给某个 用户/组织 授予权限，权限 = 资源+动作

   UpdatePermission(userID, resourceID, action) error    // 授权后 userID 可以在 resouceID 上进行 action
   UpdatePermission(orgID, resouceID, action) error      // 授权后 orgID 可以在 resouceID 上进行 action
   

2. 批量授权 给多个 用户/组织 授予权限。

   UpdatePermissions(userIDList, resourceIDList, actionList) error
   UpdatePermissions(orgIDList, resouceIDList, actionList) error
   

检查权限

检查某个用户/组织 是否有权限

CheckPermission(userID, resourceID, action) bool    // 检查 userID 是否可以在 resouceID 上进行 action
CheckPermission(orgID, resouceID, action) bool      // 检查 orgID 是否可以在 resouceID 上进行 action

查询权限

查询某个用户/组织的权限数据，其中 Permission 是权限数据的结构

GetPermissions(userID) ([]Permission, error)   // 获取 userID 的所有权限数据
GetPermissions(orgID) ([]Permission, error)    // 获取 orgID 的所有权限数据

删除权限

删除某个用户/组织的权限数据

DeletePermission(userID, resourceID, action)    // 取消 userID 在 resouceID 上进行 action 的权限
DeletePermission(orgID, resouceID, action)      // 取消 orgID 在 resouceID 上进行 action 的权限

总结

整个权限系统只有以上几个API肯定是不够的，其他的API都是常规的 用户/组织，资源，动作等的CURD，这里就不一一列出了。