restful接口规范笔记

chemzqm 发布于2019-07-25 10:46 / 287人阅读

摘要：约定查询创建替换更新删除一定要使用传输目前，作为唯一的交互格式命名规则电影电影评论过滤，查询，排序鉴权是无状态的也就是说用户请求的鉴权和以及无关，每一次请求都应该包含鉴权证明。统一使用或者认证。状态码成功返回状态，对应，成功创建。

约定

GET（Select）：查询
POST（Create）：创建
PUT（Replace）：替换
PATCH（Update）：更新
DELETE（Remove）：删除

ssl

restful API一定要使用https传输

json

目前，json作为唯一的交互格式

命名规则

snake

电影

GET /movies 
POST /movies 
GET /movies/12 
PUT /movies/12 
PATCH /movies/12 
DELETE /movies/12

电影评论

GET /movies/12/comments 
POST /movies/12/comments 
GET /movies/12/comments/5
PUT /moviess/12/comments/5 
PATCH /movies/12/comments/5 
DELETE /movies/12/comments/5

　过滤，查询，排序

https://API.com/movies?state=open&search=funny&sort=-priority,created_at

鉴权

restful API是无状态的也就是说用户请求的鉴权和cookie以及session无关，每一次请求都应该包含鉴权证明。统一使用Token或者OAuth2.0认证。

状态码

 200 ok  - 成功返回状态，对应，GET,PUT,PATCH,DELETE.
 201 created  - 成功创建。
 304 not modified   - HTTP缓存有效。
 400 bad request   - 请求格式错误。
 401 unauthorized   - 未授权。
 403 forbidden   - 鉴权成功，但是该用户没有权限。
 404 not found - 请求的资源不存在
 405 method not allowed - 该http方法不被允许。
 410 gone - 这个url对应的资源现在不可用。
 415 unsupported media type - 请求类型错误。
 422 unprocessable entity - 校验错误时用。
 429 too many request - 请求过多。

　优秀案例

https://developer.github.com/v3/

GPU云服务器云服务器 rest接口是哪个接口 api接口规范 java本地接口规范 REST

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/38146.html

api 接口管理工具

摘要：接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的，不管是线上工具还是自建工具，都是接口集成工具，主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。 api 接口管理工具现在，Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式，前后端分离之后，前端与后端都用接口（api）来沟通，这就需要我们做好 API 接口管理，所以，这次来聊聊 API 接口管理...

marser 2019-08-23 14:43 评论0 收藏0
api 接口管理工具

摘要：接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的，不管是线上工具还是自建工具，都是接口集成工具，主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。 api 接口管理工具现在，Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式，前后端分离之后，前端与后端都用接口（api）来沟通，这就需要我们做好 API 接口管理，所以，这次来聊聊 API 接口管理...

wuyumin 2019-08-16 14:27 评论0 收藏0