接口设计原则
- 使用复数单词定义资源, 如下:
-
api.example.com/users/
获取所有用户 -
api.example.com/users/{id}
获取id为参数值的用户
-
URL中的多个单词用减号(-)分隔,
-
URL中的单词字母[全小写], 非常特殊必要的情况才可以大写(如: URL中的参数变量)
-
请求参数名[全小写], 多个单词用下划线分割(_)
-
返回值为
JSON
格式, key的单词全小写, 多个单词用下划线分割(_)
api.example.com/users/
获取所有用户
api.example.com/users/{id}
获取id为参数值的用户
URL中的多个单词用减号(-)分隔,
URL中的单词字母[全小写], 非常特殊必要的情况才可以大写(如: URL中的参数变量)
请求参数名[全小写], 多个单词用下划线分割(_)
返回值为JSON
格式, key的单词全小写, 多个单词用下划线分割(_)
本文标题:RESTful 接口设计
本文链接:https://www.haomeiwen.com/subject/kutryttx.html
网友评论