前后端分离swagger配置

阳光穿透心脏的1/2处 2023-02-26 09:24 20阅读 0赞

3、运行

--------------------

2、配置

@Configuration //托管给spring
    @EnableSwagger2  //开启swagger功能的注解
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi(){
            //版本类型是swagger2
            return new Docket(DocumentationType.SWAGGER_2)
                    //通过调用自定义方法apiInfo，获得文档的主要信息
                    .apiInfo(apiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
    
    //                .apis(RequestHandlerSelectors.basePackage("com.atguigu"))//扫描该包下面的API注解
    //                .paths(PathSelectors.any())
                    .build();
        }
        /**
         * 创建该API的基本信息（这些基本信息会展现在文档页面中）
         * 访问地址：http://项目实际地址/swagger-ui.html
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("使用Swagger2 构建RESTful APIS - zy") //接口管理文档首页显示
                    .description("zy - Swagger使用演示")//API的描述
                    .termsOfServiceUrl("www.footmark.top")//网站url等
                    .version("1.0")
                    .build();
        }
    }

--------------------

1、导入依赖

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xqajEyM18_size_16_color_FFFFFF_t_70][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xqajEyM18_size_16_color_FFFFFF_t_70]: /images/20230209/a6272eda221645ae9229e5549aee9058.png