Restful Api规范

互联网应用程序的API设计理论

1.api与用户之间的协议基于http或者https协议

2.尽量将Api部署到专用域名下

3.应该将API的版本号放入URL。

4.命名规范

5.操作类型GET查询数据POST新增数据PUT修改数据DELETE删除数据

6.服务器向用户返回的状态码和提示信息

7.错误处理

8.返回结果

HTTP协议状态码

200 OK [GET] 服务器成功返回用户请求的数据

201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。

202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）

204 NO CONTENT - [DELETE]：用户删除数据成功。

400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作

401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）

404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作

406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。

410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。

422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。

500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。