关于REST API设计的文章整理

时间:2023-06-05 09:23:56

关于REST API设计的文章整理
1. rest api uri设计的7个准则
(1)uri末尾不需要出现斜杠/
(2)在uri中使用斜杠/表达层级关系
(3)在uri中可以使用连接符-提升可读性
(4)在uri中不允许出现下划线字符_
(5)在uri中优先使用小写字符
(6)在uri中不允许出现文件扩展名,而应该使用content-type生命消息类型
(7)在uri中使用复数形式
详见:http://blog.restcase.com/7-rules-for-rest-api-uri-design/

2. 5个rest api设计指导原则
(1)资源定义
(2)http方法
(3)http消息头
(4)查询参数
(5)响应状态码
详见:http://blog.restcase.com/5-basic-rest-api-design-guidelines/