Restful-编码规范

在Restful风格中，规定如下：

一、协议

• API与用户的通信协议，总是使用HTTPs协议。

二、域名

• 应该尽量将API部署在专用域名之下。

三、版本（Versioning）

• 应该将API的版本号放入URL。

• 另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。

四、路径（Endpoint）

       在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

五、请求方式（Method）

     GET（SELECT）：从服务器查询，可以在服务器通过请求的参数区分查询的方式。  
     POST（CREATE）：在服务器新建一个资源，调用insert操作。  
     PUT（UPDATE）：在服务器更新资源，调用update操作。  
     DELETE（DELETE）：从服务器删除资源，调用delete语句

六、状态码（Code）

  服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

  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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

 

 

这里要注意一下

1.html表单form中，method没有put、delete。

2.springMVC并不能直接接收到通过put、delete方式传过来的参数。

我这里的解决方式是

1.添加过滤器hiddenHttpMethodFilter，作用是将put和delete的参数获取并重新放入request中，controller便可以直接拿到这些参数。

我们需要在web.xml中配置一个过滤器

<!-- 配置过滤器 将POST请求转换为PUT和DELETE请求 -->
  <filter>
      <filter-name>HiddenHttpMethodFilter</filter-name>
      <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
      <filter-name>HiddenHttpMethodFilter</filter-name>
      <url-pattern>/*</url-pattern>
</filter-mapping>

需要注意的是，只有context-type：application/x-www-form-urlencoded的请求才会被过滤。

在表单上增加一个隐藏表单域,将HiddenHttpMethodFilter里的_method属性改为put或者delete后提交
因为只有form表单才具有post方法,而这个过滤器也只能将post方法转化,get则不行。
比如你要提交一个删除的请求
其Controller里的方法对应的
@RequestMapping(value="deleteById/{id}",method = RequestMethod.DELETE)
 //RESTFUL风格
<a class="del" href="deleteById/100">DELETE</a>//将ID为100的删除