Swagger document configuration

swagger:

swagger Is a specification and complete framework , Can generate , describe , Invocation and visualization RESTful Style Web service .

springboot Integrate swagger

Add dependency

There are two patterns , One is swagger-ui.html, One is doc.html（ Take according to your own requirements ）

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!--swagger-ui.html Pattern         -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!--doc.html Pattern         -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.2</version>
        </dependency>

  establish swagger Configuration class ：

package com.yan.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //  tell springboot You need to load this configuration class 
@EnableSwagger2 //  Enable swagger
public class SwaggerConfig {
    
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //  adopt select Return an instance , Used to control which interfaces are exposed to swagger To show .
                .select()
                //  For all api monitor 
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }


    //  establish api Basic information of ,（ This information will be displayed in the document , such as title Describe something like that ）
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("spring-web project ")
                .description(" Description of the project ").build();
    }
}

verification ：

After the project starts , You can visit localhost:8080/swagger-ui.html perhaps localhost:8080/doc.html Came to visit. .（ Choose according to your dependence on import ）

Some notes ：

Controller layer 

 Define the interface name ：@Api(tags="xxx")
 Define method name ：@ApiOperation(value="xxx")
 Definition param Attributes of parameters ：@ApiImplicitParam(name = "xx", value = "xx", paramType = "xx")
 Such as ： @ApiImplicitParam(name = "pid", value = " product id", paramType = "String")

 Entity 
 Define object name ：@ApiModel("xxx")
 Define the parameter name ：@ApiModelProperty(value = "xxx")