Restful API规范

restful api是用于在前端与后台进行通信的一套规范。使用这个规范可以让前后端开发变得更加轻松。以下将讨论这套规范的一些设计细节。

协议:

采用http或者https协议。

数据传输格式:

数据之间传输的格式应该都使用json,而不使用xml。

url链接:

url链接中,不能有动词,只能有名词。并且对于一些名词,如果出现复数,那么应该在后面加s。

比如:获取文章列表,应该使用`/articles/`,而不应该使用/get_article/

HTTP请求的方法:

GET:从服务器上获取资源。

POST:在服务器上新创建一个资源。

PUT:在服务器上更新资源。(客户端提供所有改变后的数据)

PATCH:在服务器上更新资源。(客户端只提供需要改变的属性)

DELETE:从服务器上删除资源。

示例如下:

GET /users/:获取所有用户。

POST /user/:新建一个用户。

GET /user/id/:根据id获取一个用户。

PUT /user/id/:更新某个id的用户的信息(需要提供用户的所有信息)。

PATCH /user/id/:更新某个id的用户信息(只需要提供需要改变的信息)。

DELETE /user/id/:删除一个用户。

状态码:


©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容