RESTful API思维导图
2020-04-07 14:17:07 0 举报AI智能生成
RESTful API思维导图
作者其他创作
大纲/内容
RESTful API设计规范
规范作用
API表达的是数据提供者和使用者之间的契约，通过遵循RESTful的最佳实践来定义API的URI，可降低系统间集成的成本，并有助于运维对应用的管理和运维
核心价值
The easier your API is to consume, the more people that will consume it.
核心准则
层级主要是用来对API进行分类，且层级不应太多，越靠前的就要越要稳定不变
路径组成
/{version}/{servicename}/{resource}/[{resource-id}[/{function}]
servicename=jar名称，格式：iccc-{服务名词}-service
基本规范
规则1：正斜杠分隔符（/）必须用来指示层级关系
规则2：所有名字必须以英文且全小写字母
规则3：应使用连字符（ - ）来提高URI的可读性
规则4：不得在URI中使用下划线（_）
规则5：查询参数必须采用snake_case 形式
规则6：文件扩展名不应包含在URI中
规则7：端点名称必须采用复数
规则8：URI上中禁止出现动词
规则9：结尾不应包含（/）
方法动词
GET：查询资源
POST：新增资源
PUT：更新资源
DELETE：删除资源
HEAD：探测元数据或健康状态
查询参数
排序：?sort=key|asc/desc
过滤：?filter=key 运算符 value
分页：?page=2|per_page=100
令牌：?accesstoken={accesstoken}
搜索：?search=value
内容类型
application/json
参考资料
https://www.cnblogs.com/haoliansheng/p/4719306.html
https://www.jianshu.com/p/ab639f6c19ba
职业：本科
0 条评论
下一页
