1. 接口列表
1.1. 约定说明
在地球号的设计种,API的名称和对应的权限名称是相同的。所以权限列表也就是接口列表。这里列举了这些接口的限制,T列代表接口要求的Token的种类:U代表用户令牌,A代表应用令牌。C代表令牌的颜色,分为XRGB四种。
因为只有系统权限是目前可以确定的,所以本表列举了系统权限。在系统访问的过程中,社区,角色,权限都是可以被拉黑的。
接口名称是网关控制台命名的接口名字,目前尽量保持三个字母表达动作。
修改资源为什么不用put而用set,因为在http请求里,put有POST的含义,即让一个一需要创建的资源不存在,就要立即创建,而set是设置和修改的意思。如果资源不存在,会出错。
为什么打开资源和关闭资源分别用Enable和Disable两个接口/单词来表达,如果不用两个接口,必然需要一个字段来区分,这样是的接口日志不能区分跟踪,因为日志存储并不跟踪具体的参数。dis是Disable的缩写。
早期接口是用户自己定义action,为什么后来改到网关后台设置。因为我们使用了接口泛洪策略,接口泛洪(ApiFlood)策略主要是使用数量众多的接口来简化每个接口的开发难度。
Roue:对一个角色授予某个权限,这个只需要一套接口,因为通过角色就知道这个行为是什么行为。不需要多套接口。
usro: 授权只需要一套接口,因为可以通过授权的role判断这个授权是哪个种类的。
1.2. 接口列表
| 接口名称 | 权限/动作 | 名字 | T | C | 角色 | 备注 |
|---|---|---|---|---|---|---|
| zone | ||||||
| AddZone | CreateZone | 创建社区 | U | X | Root | |
| DelZone | DeleteZone | 删除社区 | U | X | Root | |
| SetZone | UpdateZone | 更新社区 | U | X | God | |
| DolZone | DeletoZone | 软删社区 | U | X | God | |
| RccZone | RecycleZone | 回收社区 | U | X | God | |
| EnbZone | EnableZone | 开放社区 | U | X | God | |
| DisZone | DisableZone | 拉黑社区 | U | X | God | |
| OffZone | OfflineZone | 下线社区 | U | X | God | |
| OnfZone | OnlineZone | 上线社区 | U | X | God | |
| QryZone | QueryZone | 查询社区 | U | X | God | |
| QriZone | QueriZone | 私查社区 | U | X | God | |
| GetZone | GetZone | 详情社区 | U | X | God | |
| corp | ||||||
| AddCorp | CreateCorp | 创建企业 | U | B | Root | |
| DelCorp | DeleteCorp | 删除企业 | U | B | Root | |
| SetCorp | UpdateCorp | 更新企业 | U | B | God | |
| DolCorp | DeletoCorp | 软删企业 | U | B | God | |
| RccCorp | RecycleCorp | 回收企业 | U | B | God | |
| EnbCorp | EnableCorp | 开放企业 | U | B | God | |
| DisCorp | DisableCorp | 拉黑企业 | U | B | God | |
| OffCorp | OfflineCorp | 下线企业 | U | B | God | |
| OnfCorp | OnlineCorp | 上线企业 | U | B | God | |
| QryCorp | QueryCorp | 查询企业 | U | B | God | |
| QriCorp | QueriCorp | 私查企业 | U | B | God | |
| GetCorp | GetCorp | 详情企业 | U | B | God | |
| shop | ||||||
| AddShop | CreateShop | 创建店铺 | U | B | Root | |
| DelShop | DeleteShop | 删除店铺 | U | B | Root | |
| SetShop | UpdateShop | 更新店铺 | U | B | God | |
| DolShop | DeletoShop | 软删店铺 | U | B | God | |
| RccShop | RecycleShop | 回收店铺 | U | B | God | |
| EnbShop | EnableShop | 开放店铺 | U | B | God | |
| DisShop | DisableShop | 拉黑店铺 | U | B | God | |
| OffShop | OfflineShop | 下线店铺 | U | B | God | |
| OnfShop | OnlineShop | 上线店铺 | U | B | God | |
| QryShop | QueryShop | 查询店铺 | U | B | God | |
| QriShop | QueriShop | 私查店铺 | U | B | God | |
| GetShop | GetShop | 详情店铺 | U | B | God | |
| app | ||||||
| AddApp | CreateApp | 创建应用 | U | X | Root | |
| DelApp | DeleteApp | 删除应用 | U | X | Root | |
| SetApp | UpdateApp | 更新应用 | U | X | God | |
| DolApp | DeletoApp | 软删应用 | U | X | God | |
| RccApp | RecycleApp | 回收应用 | U | X | God | |
| EnbApp | EnableApp | 开放应用 | U | X | God | |
| DisApp | DisableApp | 拉黑应用 | U | X | God | |
| OffApp | OfflineApp | 下线应用 | U | X | God | |
| OnfApp | OnlineApp | 上线应用 | U | X | God | |
| QryApp | QueryApp | 查询应用 | U | X | God | |
| QriApp | QueriApp | 私查应用 | U | X | God | |
| GetApp | GetApp | 详情应用 | U | X | God | |
| token | ||||||
| AddToken | CreateToken | 创建令牌 | U | X | Root | |
| DelToken | DeleteToken | 删除令牌 | U | X | Root | |
| SetToken | UpdateToken | 更新令牌 | U | X | God | |
| DolToken | DeletoToken | 软删令牌 | U | X | God | |
| RccToken | RecycleToken | 回收令牌 | U | X | God | |
| EnbToken | EnableToken | 开放令牌 | U | X | God | |
| DisToken | DisableToken | 拉黑令牌 | U | X | God | |
| OffToken | OfflineToken | 下线令牌 | U | X | God | |
| OnfToken | OnlineToken | 上线令牌 | U | X | God | |
| QryToken | QueryToken | 查询令牌 | U | X | God | |
| QriToken | QueriToken | 私查令牌 | U | X | God | |
| GetToken | GetToken | 详情令牌 | U | X | God | |
| Rolex | ||||||
| AddRoleX | CreateXduaRole | 创建系统角色 | U | X | God | |
| DelRoleX | DeleteXduaRole | 删除系统角色 | U | X | God | |
| SetRoleX | UpdateXduaRole | 更新系统角色 | U | X | God | |
| EnbRoleX | EnableXduaRole | 开放系统角色 | U | X | God | |
| DisRoleX | DisableXduaRole | 拉黑系统角色 | U | X | God | |
| QryRoleX | QueryXduaRole | 查询系统角色 | U | X | God | |
| GetRoleX | GetXduaRole | 详情系统角色 | U | X | God | |
| RoleR | ----------- | ------------ | - | - | --- | |
| AddRoleR | CreateZoneRole | 创建社区角色 | U | X | God | |
| DelRoleR | DeleteZoneRole | 删除社区角色 | U | X | God | |
| SetRoleR | UpdateZoneRole | 更新社区角色 | U | X | God | |
| EnbRoleR | EnableZoneRole | 开放社区角色 | U | X | God | |
| DisRoleR | DisableZoneRole | 拉黑社区角色 | U | X | God | |
| QryRoleR | QueryZoneRole | 查询社区角色 | U | X | God | |
| GetRoleR | GetZoneRole | 详情社区角色 | U | X | God | |
| RoleG | ----------- | ------------ | - | - | --- | |
| AddRoleG | CreateCorpRole | 创建企业角色 | U | G | Ceo | |
| DelRoleG | DeleteCorpRole | 删除企业角色 | U | G | Ceo | |
| SetRoleG | UpdateCorpRole | 更新企业角色 | U | G | Ceo | |
| EnbRoleG | EnableCorpRole | 开放企业角色 | U | G | Ceo | |
| DisRoleG | DisableCorpRole | 拉黑企业角色 | U | G | Ceo | |
| QryRoleG | QueryCorpRole | 查询企业角色 | U | G | Ceo | |
| GetRoleG | GetCorpRole | 详情企业角色 | U | G | Ceo | |
| RoleB | ----------- | ------------ | - | - | --- | |
| AddRoleB | CreateShopRole | 创建店铺角色 | U | B | Butler | |
| DelRoleB | DeleteShopRole | 删除店铺角色 | U | B | Butler | |
| SetRoleB | UpdateShopRole | 更新店铺角色 | U | B | Butler | |
| SetRoleB | EnableShopRole | 开放店铺角色 | U | B | Butler | |
| SetRoleB | DisableShopRole | 拉黑店铺角色 | U | B | Butler | |
| QryRoleB | QueryShopRole | 查询店铺角色 | U | B | Butler | |
| GetRoleB | GetShopRole | 详情店铺角色 | U | B | Butler | |
| RuleX | ----------- | ------------ | - | - | --- | |
| AddRuleX | CreateXduaRule | 创建系统权限 | U | X | God | |
| DelRuleX | DeleteXduaRule | 删除系统权限 | U | X | God | |
| SetRuleX | UpdateXduaRule | 更新系统权限 | U | X | God | |
| EnbRuleX | EnableXduaRule | 开放系统权限 | U | X | God | |
| DisRuleX | DisableXduaRule | 拉黑系统权限 | U | X | God | |
| QryRuleX | QueryXduaRule | 查询系统权限 | U | X | God | |
| GetRuleX | GetXduaRule | 详情系统权限 | U | X | God | |
| RuleR | ----------- | ------------ | - | - | --- | |
| AddRuleR | CreateZoneRule | 创建社区权限 | U | R | God | |
| DelRuleR | DeleteZoneRule | 删除社区权限 | U | R | God | |
| SetRuleR | UpdateZoneRule | 更新社区权限 | U | R | God | |
| SetRuleR | EnableZoneRule | 开放社区权限 | U | R | God | |
| SetRuleR | DisableZoneRule | 拉黑社区权限 | U | R | God | |
| QryRuleR | QueryZoneRule | 查询社区权限 | U | R | God | |
| GetRuleR | GetZoneRule | 详情社区权限 | U | R | God | |
| Roue | ----------- | ------------ | - | - | --- | |
| AddRoue | CreateRoue | 创建角权 | U | X | God | |
| DelRoue | DeleteRoue | 删除角权 | U | X | God | |
| SetRoue | UpdateRoue | 更新角权 | U | X | God | |
| SetRoue | EnableRoue | 开放角权 | U | X | God | |
| SetRoue | DisableRoue | 拉黑角权 | U | X | God | |
| QryRoue | QueryRoue | 查询角权 | U | X | God | |
| GetRoue | GetRoue | 详情角权 | U | X | God | |
| Usro | ----------- | ------------ | - | - | --- | |
| AddUsro | CreateUsro | 创建授权 | U | B | God | |
| DelUsro | DeleteUsro | 删除授权 | U | B | God | |
| SetUsro | UpdateUsro | 更新授权 | U | B | God | |
| EnbUsro | EnableUsro | 开放授权 | U | B | God | |
| FrzUsro | FreezeUsro | 冻结授权 | U | B | God | |
| DisUsro | DisableUsro | 拉黑授权 | U | B | God | |
| QryUsro | QueryUsro | 查询授权 | U | B | God | |
| GetUsro | GetUsro | 详情授权 | U | B | God | |
| User | ----------- | ------------ | - | - | --- | |
| AddUser | CreateUser | 创建用户 | U | B | God | |
| AddUser | Signup | 注册用户 | U | B | Anonymus | |
| DelUser | DeleteUser | 删除用户 | U | B | God | |
| SetUser | UpdateUser | 更新用户 | U | B | God | |
| SetUser | EnableUser | 开放用户 | U | B | God | |
| SetUser | DisableUser | 拉黑用户 | U | B | God | |
| QryUser | QueryUser | 查询用户 | U | B | God | |
| GetUser | GetUser | 详情用户 | U | B | God | |
| Mats | ----------- | ------------ | - | - | --- | |
| AddMats | CreateMats | 创建床垫 | U | B | God | |
| DelMats | DeleteMats | 删除床垫 | U | B | God | |
| SetMats | UpdateMats | 更新床垫 | U | B | God | |
| SetMats | EnableMats | 开放床垫 | U | B | God | |
| SetMats | FreezeMats | 冻结床垫 | U | B | God | |
| SetMats | DisableMats | 拉黑床垫 | U | B | God | |
| QryMats | QueryMats | 查询床垫 | U | B | God | |
| GetMats | GetMats | 详情床垫 | U | B | God | |
| Login | ----------- | ------------ | - | - | --- | |
| AddLogin | Login | 创建登录 | A | * | God | |
| AddLogin | Logout | 创建登录 | U | B | God | |
| DelLogin | DeleteLogin | 删除登录 | U | B | God | |
| SetLogin | UpdateLogin | 更新登录 | U | B | God | |
| SetLogin | EnableLogin | 开放登录 | U | B | God | |
| SetLogin | FreezeLogin | 冻结登录 | U | B | God | |
| SetLogin | DisableLogin | 拉黑登录 | U | B | God | |
| QryLogin | QueryLogin | 查询登录 | U | B | God | |
| GetLogin | GetLogin | 详情登录 | U | B | God | |
| Vfc | ----------- | ------------ | - | - | --- | |
| AddVfc | CreateVfc | 创建验码 | A | * | * | |
| DelVfc | DeleteVfc | 删除验码 | U | B | God | |
| SetVfc | UpdateVfc | 更新验码 | U | B | God | |
| SetVfc | EnableVfc | 开放验码 | U | B | God | |
| SetVfc | FreezeVfc | 冻结验码 | U | B | God | |
| SetVfc | DisableVfc | 拉黑验码 | U | B | God | |
| QryVfc | QueryVfc | 查询验码 | U | B | God | |
| GetVfc | GetVfc | 详情验码 | U | B | God |
