使用swagger3生成springboot项目的后端文档

1.向spring容器中注入一个Docket类

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket restApi() {
        Docket docket = new Docket(DocumentationType.OAS_30);
        docket.apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("platform.controller"))
                .build();
        return docket;
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://localhost:7070/swagger-ui/index.html
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("描述信息")
                .contact(new Contact("姓名", "网址", "邮箱"))
                .version("1.0.0")
                .build();
    }
}

2.配置静态路径映射

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    /**
     * 设置静态资源映射
     * @param registry
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("开启静态资源映射...");
        registry.addResourceHandler("/swagger-ui/**").addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");
    }
}

3.放行与swagger相关的端口

注：此步非必须，只有当项目中配置了过滤器时才需要对这些端口放行

"/swagger-ui/**",
"/swagger-resources/**",
"/v3/api-docs",

4.启动项目，访问接口文档地址

接口文档的地址格式如下：

http://ip:port/swagger-ui/index.html