RestFul API

Posted 2021-03-04 水墨晨诗

根据以下几个方面来设计RESTFful API

资源路径（URI）、HTTP动词、过滤信息、状态码、错误处理、返回结果。

资源路径：在URI中一般不涉及动词。比如获取用户信息可以使用https://www.cnblogs.com/v1/user，该请求为get请求，如果要删除则使用delete。

HTTP动词：

　　　　GET：从服务器取出资源。 /user/ID获取指定用户的信息。

　　　　POST：在服务器新建一个资源。/user 新建一个用户。

　　　　PUT：在服务器更新资源（客户端提供改变后的完整资源）。/user/ID 更新指定用户的信息。

　　　　DELETE:从服务器删除资源。 user/ID 删除指定用户的信息。

过滤信息：如果数据太多，服务器端不可能一次性将所有数据都返回给客户端，API应该提供参数，过滤返回结果。?page=2&per_page=100#

状态码：服务器向用户返回的状态码和提示信息，使用标准的HTTP状态码。

　　　　200 OK 客户端请求成功，服务器端成功返回用户请求的数据。（该操作是幂等的）　　　　

　　　　201 CREATED 新建或修改数据成功。

　　　　204 NO CONTENT 删除数据成功。

　　　　400 BAD REQUEST 用户发出的请求有错误。（该操作是幂等的）

　　　　401 Unauthorized 表示该用户没有认证，无法进行当前操作。

　　　　403 Forbidden 表示用户访问是被禁止的。

　　　　404 Not Found 表示请求的资源不存在。

　　　　405 Method not allowed 表示请求的资源的时候，使用了不被支持的HTTP方法。

　　　　409 Conflict 表示请求与服务器当前状态冲突（客户端与服务器都要对服务器上的文件进行写的操作）。处理并非问题。

　　　　422 Unprocesable Entity 当创建一个对象时，发生了一个验证错误。Mostate.Isvalid==false的时候（账号或密码错误等……）

　　　　500 INTERNAL SERVER ERROR服务器发生错误，用户将无法判断发出的请求是否成功。

错误处理：如果状态码是4XX或者是5XX，应该向用户返回出错信息，一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

　　　　例如：{"error":"参数错误"}

返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范；

　　　　GET /users ：返回资源对象的列表（数组）。

　　　　GET /users/id  ：返回单个资源对象。

　　　　POST /users  ：返回新生成的资源对象。

　　　　PUT  /users/id  ：返回被更新的完整的资源对象。

　　　　DELETE  /users/id  ：返回一个空文档（此时的状态码是204）。

 

 更多状态码：https://www.cnblogs.com/vichin/p/12182501.html