jumpserver/docs/api_style_guide.md

148 lines
5.4 KiB
Markdown
Raw Normal View History

## REST API规范约定
这里仅考虑REST API的基本情况。参考
[RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)
[github api文档](https://developer.github.com/v3/)
### 协议
API与用户的通信协议总是使用HTTPs协议。
### 域名
这版api相对简单, 没有前后端分离, 没有独立app, 所以放在主域名下
```
https://example.org/api/
```
### 版本
将API的版本号放入URL
```
https://example.com/api/v1/
```
另一种做法是将版本号放在HTTP头信息中但不如放入URL方便和直观。Github采用这种做法。
### 路径
路径又称"终点"endpoint表示API的具体网址。
在RESTful架构中每个网址代表一种资源resource所以网址中不能有动词只能有名词而且所用的名词往往与数据库的表格名对应。一般来说数据库中的表都是同种记录的"集合"collection所以API中的名词也应该使用复数。
举例来说 cmdb中的assets列表, idc列表
```
https://example.com/api/v1/assets
https://example.com/api/v1/assetgroups
https://example.com/api/v1/assetgroups/:id/assets
https://example.com/api/v1/assets/:id
https://example.com/api/v1/idcs
```
一般性的增删查改(CRUD)API完全使用HTTP method加上url提供的语义url中的可变部分比如上面提到的<role_id>
一般用来传递该API操作的核心实体对象的唯一ID如果有更多的参数需要提供GET方法请使用url parameter
(例如:"?client_id=xxxxx&app_id=xxxxxx")PUT/POST/DELETE方法请使用请求体传递参数。
### HTTP Method
对于资源的具体操作类型由HTTP动词表示。
常用的HTTP动词有下面五个括号里是对应的SQL命令
- GETSELECT从服务器取出资源一项或多项
- POSTCREATE在服务器新建一个资源。
- PUTUPDATE在服务器更新资源客户端提供改变后的完整资源, 幂等
- PATCHUPDATE在服务器更新资源客户端提供改变的属性
- DELETEDELETE从服务器删除资源。
### 过滤信息
常见参数约定
```
?keyword=localhost 模糊搜索
?limit=10指定返回记录的数量
?offset=10指定返回记录的开始位置。
?page=2&per_page=100指定第几页以及每页的记录数。
?sort=name&order=asc指定返回结果按照哪个属性排序以及排序顺序。
?asset_id=1指定筛选条件
```
### 状态码
服务器向用户返回的状态码和提示信息常见的有以下一些方括号中是该状态码对应的HTTP动词
- 200 OK - [GET]服务器成功返回用户请求的数据该操作是幂等的Idempotent
- 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
- 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
- 204 NO CONTENT - [DELETE]:用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
- 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
- 403 Forbidden - [*] 表示用户得到授权与401错误相对但是访问是被禁止的。
- 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
- 406 Not Acceptable - [GET]用户请求的格式不可得比如用户请求JSON格式但是只有XML格式
- 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
### 错误处理
如果状态码是4xx就应该向用户返回出错信息。一般来说返回的信息中将error作为键名出错信息作为键值即可。
```
{
error: "Invalid API key"
}
```
### 返回结果
针对不同操作,服务器向用户返回的结果应该符合以下规范。
```
GET /collection返回资源对象的列表数组
GET /collection/resource返回单个资源对象
POST /collection返回新生成的资源对象
PUT /collection/resource返回完整的资源对象
PATCH /collection/resource返回完整的资源对象
DELETE /collection/resource返回一个空文档
```
### Hypermedia API
RESTful API最好做到Hypermedia即返回结果中提供链接连向其他API方法使得用户不查文档也知道下一步应该做什么。
比如当用户向api.example.com的根目录发出请求会得到这样一个文档。
```
{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}
```
上面代码表示文档中有一个link属性用户读取这个属性就知道下一步该调用什么API了。
rel表示这个API与当前网址的关系collection关系并给出该collection的网址
href表示API的路径title表示API的标题type表示返回类型。
Hypermedia API的设计被称为HATEOAS。
Github的API就是这种设计.
### 其它
1API的身份认证应该使用OAuth 2.0框架。
2服务器返回的数据格式应该尽量使用JSON