springbood学习小记 7：Swagger自动生成API文档

引入依赖

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

引入依赖后在主函数中添加注解

@EnableSwagger2

新建一个config类存放配置类

1，SpringFoxConfig

@Configuration
public class SpringFoxConfig {

    //访问http://localhost:8083/swagger-ui.html可以看到API文档
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Test")
                .description("")
                .termsOfServiceUrl("")
                .build();
    }
}

2,工程名+WebMvcConfig

/**
 * 描述：     配置地址映射
 */
@Configuration
public class SpringLearnWebMvcConfig implements WebMvcConfigurer {

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

配置完成后通过设置的端口，以8080为例

浏览器输入localhost:8080/swagger-ui.html

 swapper也可以进行调试，但一般调试使用postman因为postman功能更多，swapper一般用来生产api文档