RESTful api设计风格
2021-01-16 03:15
标签：存在 size 用户信息 res example 方式 定向 数据 pre 分别对应四种基本操作： xxx RESTful api设计风格 标签：存在 size 用户信息 res example 方式 定向 数据 pre 原文地址：https://www.cnblogs.com/jockming/p/12231657.html简介
设计原则
Http动词
具体实施
版本控制
参数命名规范
http://example.com/api/users/today_login 获取今天登陆的用户
http://example.com/api/users/today_login&sort=login_desc 获取今天登陆的用户、登陆时间降序排列
url命名规范
http://example.com/api/getallUsers //GET 获取所有用户
http://example.com/api/getuser/1 //GET 获取标识为1用户信息
http://example.com/api/user/delete/1 //GET/POST 删除标识为1用户信息
http://example.com/api/updateUser/1 //POST 更新标识为1用户信息
http://example.com/api/User/add //POST添加新的用户
http://example.com/api/users //GET 获取所有用户信息
http://example.com/api/users/1 //GET 获取标识为1用户信息
http://example.com/api/users/1 //DELETE 删除标识为1用户信息
http://example.com/api/users/1 //Patch 更新标识为1用户部分信息,包含在div中
http://example.com/api/users //POST 添加新的用户
统一返回数据格式
{
"code": 200,
"message": "success",
"data": {
"name": "小明",
"age": 16,
"sex": 0
}
}
{
"code": 401,
"message": "error message",
"data": null
}
http状态码
查询参数
//搜索用户，最近登录
http://example.com/api/users?recently_login_day=3
//搜索用户，按照注册时间降序
http://example.com/api/users?sort=register_time_desc
//搜索用户，按照注册时间升序、活跃度降序
http://example.com/api/users?sort=register_time_asc,liveness_desc
复杂参数
下一篇：单链表_C语言