RESTful Api基本规范

基本规范:

一、接口返回的数据格式（推荐使用JSON）

JSON属于有结构体的数据格式，本质上是字符串，轻量，有利于网络传输和解析。

二、url中不要出现动词

例如getXXXXXX、updateXXXXX的字眼。

三、HTTP请求方法类型

类型	描述
GET	请求指定的页面信息，并返回实体主体。
POST	向指定资源提交数据进行处理请求（例如提交表单或者上传文件）。数据被包含在请求体中。POST 请求可能会导致新的资源的建立和/或已有资源的修改。
PUT	从客户端向服务器传送的数据取代指定的文档的内容。
PATCH	是对 PUT 方法的补充，用来对已知资源进行局部更新 。
DELETE	请求服务器删除指定的页面。

PUT(全部更新)和PATCH（局部更新）都是对应修改操作，区别在于PATCH请求代表本次请求的要修改的只是一个完整数据中的一部分

四、HTTP状态码

状态码	状态码英文名称	描述
200	OK	请求成功。一般用于GET与POST请求
201	Created	已创建。成功请求并创建了新的资源
301	Moved Permanently	永久移动。请求的资源已被永久的移动到新URI，返回信息会包括新的URI，浏览器会自动定向到新URI。今后任何新的请求都应使用新的URI代替
302	Found	临时移动。与301类似。但资源只是临时被移动。客户端应继续使用原有URI
304	Not Modified	未修改。所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。客户端通常会缓存访问过的资源，通过提供一个头信息指出客户端希望只返回在指定日期之后修改的资源
400	Bad Request	客户端请求的语法错误，服务器无法理解
401	Unauthorized	请求要求用户的身份认证
402	Payment Required	保留，将来使用
403	Forbidden	服务器理解请求客户端的请求，但是拒绝执行此请求
404	Not Found	服务器无法根据客户端的请求找到资源（网页）。通过此代码，网站设计人员可设置"您所请求的资源无法找到"的个性页面
500	Internal Server Error	服务器内部错误，无法完成请求