swagger2生成接口文档，word

原创已于 2023-02-09 17:42:37 修改 · 571 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

swagger

当前文章被收录于：

swagger

1 篇文章 0 人学习

订阅专栏查看详情

当前文章被以下社区和专栏收录：

于 2023-02-09 17:41:32 首次发布

该文章介绍了如何在SpringBoot项目中配置Swagger2，通过`@Configuration`和`@EnableSwagger2`注解启用Swagger。`Docket`bean用于创建RESTfulAPI，设置API信息并选择特定包下的控制器生成接口文档。此外，还定义了安全方案（securitySchemes），并展示了如何通过在线工具将生成的JSON文档转换为Word文档。

配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //加了ApiOperation注解的类，才生成接口文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //包下的类，才生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(security());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXX")
                .description(""接口文档")
                .termsOfServiceUrl(""")
                .version("1.0.0")
                .build();
    }

    private List<ApiKey> security() {
        return newArrayList(
                new ApiKey("token", "token", "header")
        );
    }

}

浏览器访问：