1. 尽量将API部署在专用的域名下。 http://api.chesxs.com/v12. 要有api版本信息。 http://api.chesxs.com/v13. URL中只使用名词指定资源,不用动词,且推荐使用复数。 http://api.chesxs.com/v1/cars4. 用HTTP动词来实现资源的状态扭转。
GET 用来获取资源, POST 用来新建资源, PUT 用来更新资源, DELETE 用来删除资源, HEAD 用来获取资源头部信息, PATCH(UPDATE)更新资源的部分属性。 错误示例: GET http://api.chesxs.com/v1/deleteCar 删除车辆5. 状态码。
状态码描述2XX请求正常处理并返回3XX重定向,请求的资源位置发生变化4XX客户端发送的请求有误5XX服务器端的错误6.过滤。 ?limit=10:指定返回记录的数量 ?offset=10:指定返回记录的开始位置。 ?page=2&per_page=100:指定第几页,以及每页的记录数。 ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。 ?producy_type=1:指定筛选条件7.规范返回的数据
模板:
{ status:0,
data:{}||[],
msg:’’ }