SpringBoot ~ Restful请求风格

Restful请求风格

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

• 对于资源的具体操作类型，由HTTP动词表示。

  • 常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

    • GET（SELECT）：从服务器取出资源（一项或多项）。
    • POST（CREATE）：在服务器新建一个资源。
    • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
    • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
    • DELETE（DELETE）：从服务器删除资源。

  • 还有两个不常用的HTTP动词。

    • HEAD：获取资源的元数据。
    • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

• 举例如下：

  • GET /zoos：列出所有动物园
  • POST /zoos：新建一个动物园
  • GET /zoos/ID：获取某个指定动物园的信息
  • PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
  • PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
  • DELETE /zoos/ID：删除某个动物园
  • GET /zoos/ID/animals：列出某个指定动物园的所有动物
  • DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

• 状态码

  • 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. SpringBoot请求方法代码参考

   /**
    * @author wsyjlly
    * @create 2019.06.10 - 19:00
    * GET（SELECT）：从服务器取出资源（一项或多项）。
    * POST（CREATE）：在服务器新建一个资源。
    * PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
    * PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
    * DELETE（DELETE）：从服务器删除资源。
    **/
   @RestController
   @RequestMapping("/cors")
   public class RestfulCorsController {
       @RequestMapping("/")
       public Map<String,String> itemOperator(@RequestBody ModelMap params){
           Map<String,String> map = new HashMap<>();
           map.put("name", (String) params.get("name"));
           System.out.println(params);
           return map;
       }
   
       @PostMapping("/add")
       public Map<String,String> addItem(@RequestBody ModelMap params){
           Map<String,String> map = new HashMap<>();
           map.put("name", (String) params.get("name"));
           System.out.println(params);
           return map;
       }
   
       @DeleteMapping("/{id}")
       public String deleteItem(@PathVariable Long id){
           System.out.println(id);
           return String.valueOf(id);
       }
   
       @PutMapping("/{id}")
       public String updateItem(@PathVariable Long id){
           System.out.println(id);
           return String.valueOf(id);
       }
   
       @PatchMapping("/patch")
       public String updateItem(@RequestBody ModelMap entity){
           System.out.println(entity);
           return "STATUS";
       }
   
       @GetMapping("/{id}")
       @CrossOrigin(value = "*",allowedHeaders = "*",maxAge = 1800)
       public String getItem(@RequestParam(value = "id", required = false, defaultValue = "1601141019") @PathVariable Long id){
           System.out.println(id);
           return String.valueOf(id);
       }
   }