1、 First add Swagger Dependence

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
       <version>2.7.0</version>
 </dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.7.0</version>
</dependency>

2、 Add the corresponding annotation on the class name and method

First of all, let's popularize the commonly used annotations

@Api： Decorate the whole class , describe Controller The role of

@ApiOperation： A method that describes a class , Or an interface

@ApiParam： Single parameter description

@ApiModel： Use objects to receive parameters

@ApiModelProperty： When receiving parameters with objects , A field describing an object

@ApiResponse：HTTP In response to 1 Description (s)

@ApiResponses：HTTP Respond to the overall description

@ApiIgnore： Use this annotation to ignore this API

@ApiError ： Information returned in the event of an error

@ApiImplicitParam： A request parameter

@ApiImplicitParams： Multiple request parameters

among @ApiImplicitParam There are many attributes of

attribute	Value	effect
paramType		Query parameter type
	path	Submit data as address @PathVariable Annotation value
	query	Automatically map and assign with parameters @RequestParam Take parameters
	body	Submit... As a stream Support only POST @RequestBody Take parameters
	from	With form Form submission Support only POST
	header	Parameter in request headers Submit it inside
dataType
	Long
	String	The default is String
name		Receive parameter name
value		Description of the meaning of the receiving parameters
required
	true	Expressed as a parameter that must be passed
	false	Not a required parameter
defaultValue		The default value is

3、 Demo code

Annotation of entity class

@Data
public class Student{

    @ApiModelProperty(" Student id")
    private String Id; 
    
    @ApiModelProperty(" The student's name ")
    private String name; 

    @ApiModelProperty(" Student age ")
    private int age; 
}

Interface annotations The following demonstrates an interface that passes multiple parameters

@Api(value=" Student interface ",description = " Student interface , An increase in providing student information 、 Delete 、 Change 、 check ")
public interface StudentControllerApi {
   
  @ApiOperation(" Search for student information ")
    @ApiImplicitParams({ @ApiImplicitParam(name="name",value =" The student's name ",required=true,paramType="path",dataType="String"),
            @ApiImplicitParam(name="age",value = "
 Student age ",required=true,paramType="path",dataType="int")
    })
    public Student findStudent(String name , int age) ;
}

Controller Code , The above is only the provider of the interface , Now let's see how to receive the parameters of the interface

@RestController
@RequestMapping("/student/")
public class StudentController implements StudentControllerApi {

    @Autowired
    private StudentService studentService;

    /**
     *  according to id  Inquire about cmsconfig Page information of table 
     * @param id
     * @return
     */
    @Override
    @GetMapping("/get/{name}/{age}")
    public Student findStudent( @PathVariable("name") String name,@PathVariable("age") int age) {
        return studentService.findStudent(name,age);
    }
}

4、Swagger How interface generation works ：

1、 The system starts , Scan to api In the project Swagger2Configuration class
2、 Find the package path specified in this class and start scanning , Find the package and sub package marked with @RestController Annotated controller class
3、 according to controller Class Swagger Annotations generate interface documents .

5、 ... and 、 visit Swagger Page path

After starting the project

View interface documentation , Browser access http://localhost:8080/swagger-ui.html The port path should be changed to its own