SpringBoot整合swagger2以及使用Knife4j文档

r囧r小猫 2022-08-31 15:28 210阅读 0赞

swagger的依赖：

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

SwaggerConfiguration类：

package application;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.Arrays;
    import java.util.List;
    
    /**
     * @author: wtl
     * @License: (C) Copyright 2021, wtl Corporation Limited.
     * @Contact: 1050100468@qq.com
     * @Date: 2021/7/26 14:46
     * @Version: 1.0
     * @Description:
     */
    @Configuration
    @EnableSwagger2
    public class SwaggerConfiguration {
    
        /**
         * 默认的排除路径，排除Spring Boot默认的错误处理路径和端点
         */
        private static final List<String> DEFAULT_EXCLUDE_PATH = Arrays.asList("/error", "/actuator/**");
    
        private static final String BASE_PATH = "/**";
    
        @Bean
        public Docket api(SwaggerProperties swaggerProperties){
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .host(swaggerProperties.getHost())
                    .apiInfo(apiInfo(swaggerProperties))
                    .enable(swaggerProperties.getEnabled())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                    .paths(PathSelectors.any())
                    .build();
    
        }
    
    
        private ApiInfo apiInfo(SwaggerProperties swaggerProperties)
        {
            return new ApiInfoBuilder()
                    .title(swaggerProperties.getTitle())
                    .description(swaggerProperties.getDescription())
                    .license(swaggerProperties.getLicense())
                    .licenseUrl(swaggerProperties.getLicenseUrl())
                    .termsOfServiceUrl(swaggerProperties.getTermsOfServiceUrl())
                    .contact(new Contact(swaggerProperties.getContact().getName(), swaggerProperties.getContact().getUrl(), swaggerProperties.getContact().getEmail()))
                    .version(swaggerProperties.getVersion())
                    .build();
        }
    }

SwaggerProperties类：

package application;
    
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import org.checkerframework.checker.units.qual.A;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * @author: wtl
     * @License: (C) Copyright 2021, wtl Corporation Limited.
     * @Contact: 1050100468@qq.com
     * @Date: 2021/7/26 14:50
     * @Version: 1.0
     * @Description:
     */
    @Data
    @Component
    //@ConfigurationProperties
    //编写项目代码时，我们要求更灵活的配置，更好的模块化整合。在 Spring Boot 项目中，为满足以上要求，我们将大量的参数配置在 application.properties 或 application.yml 文件中，通过 @ConfigurationProperties 注解，我们可以方便的获取这些参数值
    @ConfigurationProperties("swagger2")
    public class SwaggerProperties {
        /**
         * 是否开启swagger
         */
        private Boolean enabled = true;
    
        /**
         * swagger会解析的包路径
         **/
        private String basePackage = "";
    
        /**
         * swagger会解析的url规则
         **/
        private List<String> basePath = new ArrayList<>();
    
        /**
         * 在basePath基础上需要排除的url规则
         **/
        private String selectPath = "/test/**";
    
        /**
         * 标题
         **/
        private String title = "";
    
        /**
         * 描述
         **/
        private String description = "";
    
        /**
         * 版本
         **/
        private String version = "";
    
        /**
         * 许可证
         **/
        private String license = "";
    
        /**
         * 许可证URL
         **/
        private String licenseUrl = "";
    
        /**
         * 服务条款URL
         **/
        private String termsOfServiceUrl = "";
    
        /**
         * host信息
         **/
        private String host = "";
    
        /**
         * 联系人信息
         */
        private Contact contact = new Contact();
    
        /**
         * 全局统一鉴权配置
         **/
        private Authorization authorization = new Authorization();
    
    
        @Data
        @NoArgsConstructor
        public static class Contact{
            /**
             * 联系人
             **/
            private String name = "";
            /**
             * 联系人url
             **/
            private String url = "";
            /**
             * 联系人email
             **/
            private String email = "";
        }
    
        @Data
        @NoArgsConstructor
        public static class Authorization {
    
            /**
             * 鉴权策略ID，需要和SecurityReferences ID保持一致
             */
            private String name = "";
    
            /**
             * 需要开启鉴权URL的正则
             */
            private String authRegex = "^.*$";
    
        }
    }

swagger2的ui界面地址：

**[http://localhost:8082/swagger-ui.html][http_localhost_8082_swagger-ui.html] **

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0bDE5OTI_size_16_color_FFFFFF_t_70][]

**springboot整合Knife4j：**

**依赖：**

<dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>3.0.3</version>
            </dependency>

**Knife4j的文档地址：**

**[http://localhost:8082/doc.html\#/home][http_localhost_8082_doc.html_home]**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0bDE5OTI_size_16_color_FFFFFF_t_70 1][]

[http_localhost_8082_swagger-ui.html]: http://localhost:8082/swagger-ui.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0bDE5OTI_size_16_color_FFFFFF_t_70]: /images/20220829/be9060c06a0f4ac6adf91d779f21846e.png
[http_localhost_8082_doc.html_home]: http://localhost:8082/doc.html#/home
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0bDE5OTI_size_16_color_FFFFFF_t_70 1]: /images/20220829/2eb168cffc994999be4c5958298c3a6a.png