swagger的使用

小羊炒饭

已于 2022-05-30 19:04:22 修改

阅读量71

点赞数

文章标签： java

于 2022-05-30 18:57:40 首次发布

本文链接：https://blog.csdn.net/qq_45948401/article/details/125052092

版权

1、导入依赖

<!--swagger-->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- 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>

2、配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("用户的接口文档")
                .description("本文档描述了用户接口定义")
                .version("1.0")
                .contact(new Contact("小羊炒饭", "https://blog.csdn.net/qq_45948401?type=blog", "xxxx@xx.com"))
                .build();
    }
    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了管理人员接口定义")
                .version("1.0")
                .contact(new Contact("小羊炒饭", "https://blog.csdn.net/qq_45948401?type=blog", "xxxx@xx.com"))
                .build();
    }

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi") // 用户组
                .apiInfo(webApiInfo()) // 组的信息
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))  // 用户接口的判断
                .build();

    }
    @Bean
    public Docket adminApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi") // 管理组
                .apiInfo(adminApiInfo()) // 组的信息
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }
}