接口规范
Web API接口规范:restful
2000年Roy Fielding博士在其博士论文中提出REST(Representational State Transfer)风格的软件架构模式后,REST就基本上迅速取代了复杂而笨重的SOAP,成为Web API的标准了。
RESTful凭借其强大、简捷、易上手的特点,成为目前最流行的 API 设计规范。
url设计
例如:https://api.oldboy.com/v2/users/?limit=3&search=fxyadela
请求方式代表操作方式
操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作。
'''
https://api.baidu.com/books - get请求:获取所有书
https://api.baidu.com/books/1 - get请求:获取主键为1的书
https://api.baidu.com/books - post请求:新增一本书书
https://api.baidu.com/books/1 - put请求:整体修改主键为1的书
https://api.baidu.com/books/1 - patch请求:局部修改主键为1的书
https://api.baidu.com/books/1 - delete请求:删除主键为1的书
'''
网络状态码
正常响应
- 响应状态码2xx
- 200:常规请求
- 201:创建成功
重定向响应
- 响应状态码3xx
- 301:永久重定向
- 302:暂时重定向
客户端异常
- 响应状态码4xx
- 403:请求无权限
- 404:请求路径不存在
- 405:请求方法不存在
服务器异常
- 响应状态码5xx
- 500:服务器异常
响应结果
响应数据要有状态码、状态信息以及数据本身 。
{
"status":0, //状态响应码
"message":"ok", //状态信息
"results":[ //响应数据
{
"name":"肯德基(罗餐厅)",
"location":{
"lat":31.415354,
"lng":121.357339
},
"address":"月罗路2380号",
"province":"上海市",
"city":"上海市",
"area":"宝山区",
"street_id":"339ed41ae1d6dc320a5cb37c",
"telephone":"(021)56761006",
"detail":1,
"uid":"339ed41ae1d6dc320a5cb37c"
}
...
]
}