How to use swagger2

Swagger It provides us with a set of methods to automatically generate documents through code and comments , This is a guarantee API The timeliness of documentation will help a lot . Can help us design 、 structure 、 Record and use Rest api

• Introduce dependencies

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

• take swagger Configuration injection spring

/** * @Configuration *  The first declaration is the configuration file class  * @EnableSwagger2 *  Turn on swagger function  */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    

    /** *  Use swagger You need to create a summary .Docket *  The summary parameters are as follows ： *  Type of document ：DocumentationType.SWAGGER_2 *  Documents are made up of a series of selectors ：api path * select()  Set up apis and paths() * apis  Find out which controller The interface of  *  Get all ：RequestHandlerSelectors.any() *  If you want to get a specified package ：RequestHandlerSelectors.basePackage("com.fanfan.controller") * path  Filter in the found interface  * @return */
    @Bean
    public Docket api(){
    
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.basePackage("com.fanfan.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    /** *  Introduction to customized documents  *  adopt apiInfBuilder establish apiInfo *  Parameters can be set  title description version  wait  * @return */
    private ApiInfo apiInfo(){
    
        return new ApiInfoBuilder()
                .title("spring-boot-swagger")
                .description(" This is an easy one demo")
                .version("1.0")
                .build();
    }
}

• Browser open
  • http://localhost:8090/swagger-ui.html

Test it ：

controller：

/** * @Api  Declare the functions of a series of interfaces , Put it in controller above  * @ApiOperation  Declare the functions of specific interfaces   Put it in controller Method above  */
@RestController
@Api(tags = " Test related interfaces ", description = " Play test CURD")
public class TestController {
    

    @GetMapping("/test")
    @ApiOperation(" The first test interface ")
    public void test(){
    
        System.out.println(1);
    }

    /** * @ApiIgnore  Do not show this interface  * @param test * @return */
    @PostMapping("/add")
    @ApiOperation(" Test name ")
    public String add(Test test){
    
        return "add";
    }

    @ApiOperation(" Delete the guest interface ")
    @ApiImplicitParam(name = "id", value = " test id")
    @PostMapping("/delete")
    public String delete(Long id){
    
        return "delete";
    }
}

bean file ：

/** * @ApiModel(" The guest ")  Declaration example  * @ApiModelProperty(" name ")  Declare the name of the instance property , Parameter display for interface  */
@Data
@AllArgsConstructor
@ApiModel(" Test case ")
public class Test {
    
    @ApiModelProperty(" name ")
    private String name;
    @ApiModelProperty(" role ")
    private String role;
}