RESTfulAPI设计指南.docx

RESTfulAPI设计指南
RESTfulAPI设计指南
RESTfulAPI设计指南
RESTful API 设计指南
网络应用程序，分为前端和后端两个部分。目前的发展趋向，就是前。
?sortby=name&order=asc ：指定返回结果依据哪个属性排序，以及排序次序。
?animal_type_id=1 ：指定挑选条件
参数的设计同意存在冗余，即同意 API 路径和 URL 参数有时有重复。比方， GET /zoo/ID/animals 与
GET /animals?zoo_id=ID 的含义是同样的。
七、状态码（ Status Codes）
服务器向用户返回的状态码和提示信息， 常有的有以下一些 （方括号中是该状态码对应的 HTTP 动词）。
RESTfulAPI设计指南
RESTfulAPI设计指南
RESTfulAPI设计指南
? 200 OK - [GET] ：服务器成功返回用户恳求的数据，该操作是幂等的（ Idempotent ）。
RESTfulAPI设计指南
RESTfulAPI设计指南
RESTfulAPI设计指南
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 - [*] ：服务器发生错误，用户将没法判断发出的恳求是
否成功。
状态码的完好列表拜见。
八、错误办理（ Error handling ）
假如状态码是 4xx ，就应当向用户返回犯错信息。一般来说，返回的信息中将 error 作为键名，犯错信
息作为键值即可。
{
error : "Invalid API k