In projects with separate front and rear ends , Between the front and back end is the interface for request and response , When the back end provides a request to the front end, it will expose a URL;URL Your design cannot be arbitrary , It needs to comply with certain design specifications ---RESTful

Catalog

One 、RESTful brief introduction ：

Two 、RESTful standard ：

3、 ... and 、RESTful- Interface ：

One 、RESTful brief introduction ： 

         RESTful It's a kind of web api Standards for , It's a kind of url design code .

Two 、 RESTful standard ：

        RESTful Specifications need to follow three rules , They are as follows ：

1. Every URL The request path represents the only resource on the server
2. Different requests are used to represent different operations
3. The resource expression form of interface response adopts json

（1）、  Every URL The request path represents the only resource on the server ; If delete , In traditional url In design , The same url route （http://localhost:8080/goods/delete）, So not satisfied RESTful The first rule to be followed in the specification , And in the RESTful In the design, each URL The request path represents the only resource on the server （ The path is unique ）

Conventional url Design ：

        http://localhost:8080/goods/delete?goodId=1      goods 1

        http://localhost:8080/goods/delete?goodId=2      goods 2

RESTful Design ：

        http://localhost:8080/goods/delete/1      goods 1

        http://localhost:8080/goods/delete/2      goods 2

 @ApiOperation(value = " Product deletion function ")
    @RequestMapping(value = "/delete/{gid}",method = RequestMethod.DELETE)
    public ResultVo addGoods(@PathVariable("gid") int gid) {
        System.out.println(gid);
        return null;
    }

Open the interface document ：http://localhost:8080/doc.html debug

  Console view results ： Output “1”, The request is successful ~

 （2）、 Different requests are used to represent different operations .springmvc Yes RESTful Style provides good support , Before we define an interface url when , Can pass   @RequestMapping(value = "/delete/{gid}",method = RequestMethod.DELETE) Specify request method . You can also use specific request mode annotations for measurement

package com.xgsm.Fmmall.controller;

import com.xgsm.Fmmall.vo.ResultVo;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@Api(value = " Provide product addition 、 modify 、 Delete and query related interfaces ", tags = " Commodity management ")
@RequestMapping("/goods")
public class GoodsController {
    @ApiOperation(value = " Product add function ")
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    public ResultVo addGoods() {
        return null;
    }

    @ApiOperation(value = " Product deletion function ")
    @RequestMapping(value = "/delete/{gid}",method = RequestMethod.DELETE)
    public ResultVo addGoods(@PathVariable("gid") int gid) {
        System.out.println(gid);
        return null;
    }

    @ApiOperation(value = " Product modification function ")
    @RequestMapping(value = "/update",method = RequestMethod.PUT)
    public ResultVo updateGoods() {
        return null;
    }

    @ApiOperation(value = " Commodity inquiry function ")
    @RequestMapping(value = "/get",method = RequestMethod.GET)
    public ResultVo getGoods() {
        return null;
    }
}

You can also write : j take @RequestMapping(value = "/add", method = RequestMethod.POST) It's written in @PostMapping(value = "/add")

package com.xgsm.Fmmall.controller;

import com.xgsm.Fmmall.vo.ResultVo;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
@Api(value = " Provide product addition 、 modify 、 Delete and query related interfaces ", tags = " Commodity management ")
@RequestMapping("/goods")
public class GoodsController {
    @ApiOperation(value = " Product add function ")
    @PostMapping(value = "/add")
    public ResultVo addGoods() {
        return null;
    }

    @ApiOperation(value = " Product deletion function ")
    @DeleteMapping(value = "/delete/{gid}")
    public ResultVo addGoods(@PathVariable("gid") int gid) {
        System.out.println(gid);
        return null;
    }

    @ApiOperation(value = " Product modification function ")
    @PutMapping(value = "/update")
    public ResultVo updateGoods() {
        return null;
    }

    @ApiOperation(value = " Commodity inquiry function ")
    @GetMapping(value = "/get")
    public ResultVo getGoods() {
        return null;
    }
}

（3）、 The resource expression form of interface response adopts json, Because the returned data needs to be json Format , At this time, we will use @ResponseBody annotation , But because all the data we need to return is json Format , So we can use in front of the class @ResponseBody Make a statement with comments .

         But in RESTful In style , Provides @RestController Note to replace @Controller、@ResponseBody