API网关设计:Vapor与Kitura实现
1. URI设计
在设计API时,顶级URI的设计至关重要。它不仅能在不影响现有功能的前提下扩展Web服务的特性,还能为实现增加可扩展性,使得每个顶级资源可以由不同系统上的服务提供。URI设计遵循只使用名词,不使用动词或操作的约定,因为每个URI端点实际上代表一种类型的资源。
对于跨不同子应用共享的资源,可以将它们放在顶级,例如:
- /api/account :管理注册用户的管理权限。
- /api/configuration :设置影响所有子应用的全局配置。
- /api/profile :维护注册用户的个人资料。
在子应用中,可以映射出所有主要子资源的URI。对于适用于端点上所有资源的操作,可直接使用顶级端点;对于适用于特定资源的操作,通常使用ID来指示特定的子资源。以 myJournal 应用为例,其顶级资源和子资源的URI如下:
- /api/journal
- /api/journal/{id} ,其中 /api/journal/{id} 子资源适用于特定的日记条目。
2. HTTP方法分配
有了明确定义的URI和资源表示,就可以在资源URI上定义应用中的所有操作。下面是不同操作对应的HTTP方法:
| 操作 | HTTP方法 | URI | 说明 |
| — | — | — | — |
| 浏览所有日记条
超级会员免费看
订阅专栏 解锁全文
1724

被折叠的 条评论
为什么被折叠?



