restful编码规范

1、HTTP动词
动词
描述
GET（select） 从服务器取出一个/多个资源
POST（create）
在服务器新建一个资源
PATCH（update）
在服务器更新资源（客户端提供改变的属性）
PUT（update） 在服务器更新资源（客户端提供改变后的完整资源）
DELETE（delete）
从客户端删除资源
image.png

2、swagger规范
注解
对象范围 使用位置 详细参数 例子
@Api 协议集描述
controller类上
value：URL路径值

description：对api资源的详细描述

image.png
@ApiOperation
协议描述
controller方法上
value：接口操作简洁

notes：接口描述

image.png

image.png

@ApiResponses response集
controller方法上

@ApiResponse
response
@ApiResponses里面
用于表示一组响应，一般用于表达错误的响应信息；

image.png
@ApiParam
参数描述
在Rest接口上、Rest接口参数前面

@ApiImplicitParams 非对象参数集
controller方法上

@ApiImplicitParam 非对象参数
@ApiImplicitParams方法里面
name：属性名称

value：属性介绍

required：是否属性必填

dataType：数据类型

image.png

多个参数，需要使用@ApiImplicitParams包裹；

@ApiModel 描述返回对象的意义
出入对象上 value：实体类的描述
@ApiModelProperty 对象属性 出入对象的字段上 value：字段介绍
注：@ApiImplicitParam比@ApiParam使用范围更广，非JAX-RS场合，只能使用@ApiImplicitParam。

3、状态码
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

4、返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）

GET /collection/resource：返回单个资源对象

POST /collection：返回新生成的资源对象

PUT /collection/resource：返回完整的资源对象

PATCH /collection/resource：返回完整的资源对象

DELETE /collection/resource：返回一个空文档

5、过滤信息
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量

https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

6、代码实例
（1）controller

@Api

@ApiOperation

@ApiParam

@ApiImplicitParams、@ApiImplicitParam

@ApiResponses、@ApiResponse

（2）出入参

@ApiModel

@ApiModelProperty