SpringBoot配置Swagger

Posted csdn_20210509

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot配置Swagger相关的知识,希望对你有一定的参考价值。

添加依赖

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

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

代码配置

@Configuration
@EnableSwagger2
public class SwaggerConfig 
    @Bean
    public Docket webApiConfig() 
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("web")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.and(PathSelectors.regex("/web/.*")))
                .build();
    

    @Bean
    public Docket adminApiConfig() 
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("admin")
                .apiInfo(adminApiInfo())
                .select()
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    

    private ApiInfo webApiInfo() 
        return new ApiInfoBuilder()
                .title("网站的API文档")
                .description("本文档描述了在线教育网站的api接口定义")
                .version("1.0")
                .contact(new Contact("xiaokeli", "http://xiaokeli.zone", "393072365@qq.com"))
                .build();
    

    private ApiInfo adminApiInfo() 
        return new ApiInfoBuilder()
                .title("后台管理系统的API文档")
                .description("本文档描述了在线教育后台管理系统的api接口定义")
                .version("1.0")
                .contact(new Contact("xiaokeli", "http://xiaokeli.zone", "393072365@qq.com"))
                .build();
    

以上是关于SpringBoot配置Swagger的主要内容,如果未能解决你的问题,请参考以下文章

Swagger--介绍及SpringBoot集成Swagger

Springboot + Swagger3 配置

springboot项目配置swagger2示例

SpringBoot整合Springfox-Swagger2

springboot配置swagger-rest文档

Springboot系列 集成接口文档swagger,使用,测试