关于Knife4j框架基于Swagger2的在线API文档框架

清疚 2024-03-25 23:15 30阅读 0赞

![在这里插入图片描述][bc177c6ee1914fc6b7d552d30a2f2dd0.png]  
![在这里插入图片描述][cde363bc826d46e98f48f400a3f76187.png]  
![在这里插入图片描述][3411f0abf93a439eb2fac29c665c07d2.png]  
![在这里插入图片描述][d4995ea4b2eb469da884c3e035fac229.png]  
![在这里插入图片描述][e84641826c704714a18df1efa26e08cf.png]  
![在这里插入图片描述][ff8d7190324a4c3b9fd1bb7db7bb3665.png]

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

![在这里插入图片描述][c1180546344f4468a6ae77534edb8d9e.png]

package cn.tedu.csmall.product.config;
    
    import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    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.EnableSwagger2WebMvc;
    
    /**
     * Knife4j配置类
     *
     * @author java@tedu.cn
     * @version 0.0.1
     */
    @Slf4j
    @Configuration
    @EnableSwagger2WebMvc
    public class Knife4jConfiguration {
        
    
        /**
         * 【重要】指定Controller包路径
         */
        private String basePackage = "cn.tedu.csmall.product.controller";
        /**
         * 分组名称
         */
        private String groupName = "product";
        /**
         * 主机名
         */
        private String host = "http://java.tedu.cn";
        /**
         * 标题
         */
        private String title = "酷鲨商城在线API文档--商品管理";
        /**
         * 简介
         */
        private String description = "酷鲨商城在线API文档--商品管理";
        /**
         * 服务条款URL
         */
        private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
        /**
         * 联系人
         */
        private String contactName = "Java教学研发部";
        /**
         * 联系网址
         */
        private String contactUrl = "http://java.tedu.cn";
        /**
         * 联系邮箱
         */
        private String contactEmail = "java@tedu.cn";
        /**
         * 版本号
         */
        private String version = "1.0.0";
    
        @Autowired
        private OpenApiExtensionResolver openApiExtensionResolver;
    
        public Knife4jConfiguration() {
        
            log.debug("创建配置类对象：Knife4jConfiguration");
        }
    
        @Bean
        public Docket docket() {
        
            String groupName = "1.0.0";
            Docket docket = new Docket(DocumentationType.SWAGGER_2)
                    .host(host)
                    .apiInfo(apiInfo())
                    .groupName(groupName)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage(basePackage))
                    .paths(PathSelectors.any())
                    .build()
                    .extensions(openApiExtensionResolver.buildExtensions(groupName));
            return docket;
        }
    
        private ApiInfo apiInfo() {
        
            return new ApiInfoBuilder()
                    .title(title)
                    .description(description)
                    .termsOfServiceUrl(termsOfServiceUrl)
                    .contact(new Contact(contactName, contactUrl, contactEmail))
                    .version(version)
                    .build();
        }
    }

![在这里插入图片描述][133cf8acc15a482ab610e88add38e684.png]

knife4j:
      enable: true

## 完成后，重启项目，可以通过 http://localhost:9080/doc.html 访问。 ##

## 配置在线API文档 ##

![在这里插入图片描述][6bb331ef46664f4fb22bbd225e747c60.png]  
![在这里插入图片描述][a91f86d2adf54b57a14ca4844c51ae42.png]  
![在这里插入图片描述][384fa538b63f4bb98f19a53f4e130499.png]  
![在这里插入图片描述][cdbf6d787bc24991b91ac00ea80fcd3b.png]  
![在这里插入图片描述][24d6bbaff3a14509a26099576cfeda34.png]  
![在这里插入图片描述][fa54c285ae214dcb948ffa1bdc2ad945.png]  
![在这里插入图片描述][8585c319cef3473ba65899490c456993.png]

[bc177c6ee1914fc6b7d552d30a2f2dd0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/beb5e5d4b2b1405fbcbcb26d942faafd.png
[cde363bc826d46e98f48f400a3f76187.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/ba84a20b71ae46aba78788186748acf3.png
[3411f0abf93a439eb2fac29c665c07d2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/0c1d684715e84344b533a342482b6919.png
[d4995ea4b2eb469da884c3e035fac229.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/304afeb0edf14ab685ea7392d167397c.png
[e84641826c704714a18df1efa26e08cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/2cc5397a5a6f4b9bbd3bee5d6075df4c.png
[ff8d7190324a4c3b9fd1bb7db7bb3665.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/fdd9bfd990dd44f4adf531d1f690c74c.png
[c1180546344f4468a6ae77534edb8d9e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/99f25e40eb8f4995844c50fc0c7b2f85.png
[133cf8acc15a482ab610e88add38e684.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/371b8ea22e63460fa2020d3635bc52d2.png
[6bb331ef46664f4fb22bbd225e747c60.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f0e8738835ff440e871c2056cef6fa0d.png
[a91f86d2adf54b57a14ca4844c51ae42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/bb6341faba084ee886df99be983fe129.png
[384fa538b63f4bb98f19a53f4e130499.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/5ad8ec85dfd6429f911f6446fd6ed23e.png
[cdbf6d787bc24991b91ac00ea80fcd3b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/92714b9be16b412dab5fd51d2e63c006.png
[24d6bbaff3a14509a26099576cfeda34.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/48d60269d2c848359f48273d77eaea9a.png
[fa54c285ae214dcb948ffa1bdc2ad945.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/ba8cb53c416a49f4996e65d759b82c6b.png
[8585c319cef3473ba65899490c456993.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/ee04a2482708467a860a4ba10072c604.png