原文地址:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
- API与用户通信,总是使用https协议
- 尽量部署API在专用域名下,API不扩展,放在主域名后面. https://example.org/api/
- 版本放在URI里,Github推荐这种用法,或者放在头部HTTP 头信息中
- 网址代表一种资源,网址中不含动词,只有名词,名词为复数。https://api.example.com/v1/employees
- HTTP动词,get,post(非幂等),put,patch,delete.不常用,head获得资源元数据,options获取信息,哪些属性客户端可改变
- 数量多,用过滤 ?limt..
- 状态码
- 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
- 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
- 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
- 204 NO CONTENT - [DELETE]:用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
- 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
- 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
- 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
- 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
- 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
- 错误处理
- 返回结果
- hypermedia API 返回结果中提供链接
- 其他 尽量返回用json,api认证oauth2.0