pythonrestfulapi接⼝规范_restfulapi接⼝规范
简介：
REST：英⽂representational state transfer直译为表现层状态转移，或者表述性状态转移。
为什么需要Restful？
URL具有很强可读性的，具有⾃描述性
规范化请求过程和返回结果
资源描述与视图的松耦合
可提供OpenAPI，便于第三⽅系统集成，提⾼互操作性
提供⽆状态的服务接⼝，降低复杂度，可提⾼应⽤的⽔平扩展性
1、版本号
命名版本号可以解决版本不兼容问题，在设计 RESTful API 的⼀种实⽤的做法是使⽤版本号。⼀般情况下，我们会在 url 中保留旧版本号，并同时兼容多个版本
【GET】  /v1/users/{user_id}  // 版本 v1 的查询⽤户列表的 API 接⼝
【GET】  /v2/users/{user_id}  // 版本 v2 的查询⽤户列表的 API 接⼝
2、资源路径
URI 不能包含动词，只能是名词(命名名词的时候，要使⽤⼩写、数字及下划线来区分多个单词)。
资源的路径应该从根到⼦依次如下:
/{resources}/{resource_id}/{sub_resources}/{sub_resource_id}/{sub_resource_property}
【POST】  /v1/users/{user_id}/roles/{role_id} // 添加⽤户的⾓⾊
有的时候，当⼀个资源变化难以使⽤标准的 RESTful API 来命名，可以考虑使⽤⼀些特殊的 actions 命名。
/{resources}/{resource_id}/actions/{action}
【PUT】  /v1/users/{user_id}/password/actions/modify // 密码修改
3、请求⽅式
【GET】          /users                # 查询⽤户信息列表
【GET】          /users/1001          # 查看某个⽤户信息
【POST】        /users                # 新建⽤户信息
【PUT】          /users/1001          # 更新⽤户信息(全部字段)
【PATCH】        /users/1001          # 更新⽤户信息(部分字段)
【DELETE】      /users/1001          # 删除⽤户信息
【PATCH】⼀般不⽤，⽤【PUT】
4、查询参数
RESTful API 接⼝应该提供参数，过滤返回结果。
【GET】  /{version}/{resources}/{resource_id}?offset=0&limit=20
5、响应参数
JSON格式(code、data、msg)
6、状态码
使⽤适合的状态码很重要，⽽不应该全部都返回状态码 200状态码，可根据以下标准按照项⽬扩展⾃⾝状态码：
200~299段 表⽰操作成功：
200 操作成功，正常返回
201 操作成功，已经正在处理该请求
300~399段 表⽰参数⽅⾯的异常
300 参数类型错误
301 参数格式错误
302 参数超出正常取值范围
303 token过期
304 token⽆效
400~499段 表⽰请求地址⽅⾯的异常：
400 不到地址
500~599段 表⽰内部代码异常：
影视资源站采集api接口数据500 服务器代码异常

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。