美文网首页
Swagger详细配置

Swagger详细配置

作者: Binary_r | 来源:发表于2021-01-16 13:35 被阅读0次
    @Configuration
    @EnableOpenApi
    public class SwaggerConfig {
    
        /**
         * 创建API应用
         * apiInfo() 增加API相关信息
         * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
         * 本例采用指定扫描的包路径来定义指定要建立API的目录。
         *
         * @return
         */
        @Bean
        public Docket createRestApi() {
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .groupName("默认分组")
                    //是否启动swagger
                    .enable(true)
                    .select()
                    //配置扫描的包  RequestHandlerSelectors.any()  扫描全部
                    //withClassAnnotation 扫描类上的注解,参数是一个注解的反射对象
                    //withMethodAnnotation   扫描方法上的注解
                    .apis(RequestHandlerSelectors.basePackage("com.sht.shoesboot.controller"))
                    //过滤的路径  .paths(PathSelectors.ant("path"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        /**
         * 创建该API的基本信息(这些基本信息会展现在文档页面中)
         * 访问地址:http://项目实际地址/swagger-ui.html
         *
         * @return
         */
        private ApiInfo apiInfo() {
    
            Contact contact = new Contact("xxx", "http://eurasia.plus/swagger-ui.html", "xxx@aliyun.com");
    
            return new ApiInfoBuilder()
                    .title("鞋靴直销系统 APIs")
                    //描述
                    .description("api接口文档")
                    .termsOfServiceUrl("http://eurasia.plus/swagger-ui.html")
                    .contact(contact)
                    .version("1.0")
                    .build();
        }
    }
    
    

    相关文章

      网友评论

          本文标题:Swagger详细配置

          本文链接:https://www.haomeiwen.com/subject/tksnaktx.html