Swagger -- the most popular API framework in the world

swagger characteristic

• Restful Api Online automatic document generation tool => Api Documentation and Apl Definition synchronization update
• Run directly and test online Api Interface
• Almost all languages are supported

Official website ：API Documentation & Design Tools for Teams | Swagger

stay springboot Integration in the project swagger

1. Create a new one springboot（Web） project

2. Import correlation dependency （ We import here 2.9.2 Version of ）

1）springfox-swagger2

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

2）springfox-swagger-ui

 <!-- 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>

3. To configure Swagger->config

@Configuration
@EnableSwagger2   // Turn on swagger
public class SwaggerConfig {

}

4. test run ： http://localhost:8300/swagger-ui.html

notes ： If you visit swagger-ui.html When the page is , appear No handler found for GET /swagger-ui.html Inaccessible issues

reason ：

This mistake , It is caused by the problem of resource mapping . We are visiting swagger-ui.html When the page is , This swagger-ui.html All related front-end static files are in springfox-swagger-ui-2.9.2.jar Inside . Directory as follows ：

and Spring Boot Autoconfig itself does not automatically turn /swagger-ui.html This path is mapped to the corresponding directory META-INF/resources/ below , So we can't visit .

resolvent :

You need to add a configuration class ( Or in your original webMvcConfig in overwrite This addResourceHandlers Method , Can solve .

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

Swagger Configuration of

In the just written SwaggerConfig Class swagger Of Apl Basic information of the document

@Configuration
@EnableSwagger2  // Turn on swagger
public class SwaggerConfig {

    // To configure swagger Of docket example 
    @Bean
    public Docket docket(){
        return new Docket(SWAGGER_2)// Version is swagger2
                .groupName("szny")
                .apiInfo(apiInfo());   //api Information 
    }
    // To configure swagger Of api Information 
    private ApiInfo apiInfo(){
        // The author information 
        Contact contact = new Contact("yk", "https://blog.csdn.net/weixin_72076848", "xx");
        return new ApiInfo(" Digital agriculture system swagger file ",
                " Digital agriculture system ",
                "1.0",
                "https://blog.csdn.net/weixin_72076848",
                contact ,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }

}

To configure swagger Scanning interface of

// To configure swagger Of docket example 
    @Bean
    public Docket docket(){
        return new Docket(SWAGGER_2)// Version is swagger2
                .groupName("szny")
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors: Configure how to scan the interface 
                //basePackage: Scan the specified package 
                //any: Scan all   none: Don't scan 
                .apis(RequestHandlerSelectors.basePackage("com.jpzh.bis.controller"))
                //ant: Filter the specified path  any: Filter all  none: No filtering 
                //.paths(PathSelectors.any())
                .build();   //api Information 
    }

swagger Group function of , It is applicable to collaborative development within the project team

@Bean
    public Docket docket1(){
        return new Docket(SWAGGER_2)
                .groupName("A");
    }
    @Bean
    public Docket docket2(){
        return new Docket(SWAGGER_2)
                .groupName("B");
    }
    @Bean
    public Docket docket3(){
        return new Docket(SWAGGER_2)
                .groupName("B");
    }

ok, After learning this, you can carry out simple swagger Integrated , Let's try ！