springboot集成knife4j

傷城~ 2022-10-31 12:23 34阅读 0赞

# 项目： https://github.com/nlxs0511/springmybatisplus.git #

# 提交版本：集成knife4j实现风格化API文档 #

![20210222175918649.png][]

# 1.pom.xml knife4j-spring-boot-starter的版本自己决定 #

<dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>2.0.2</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-validation</artifactId>
            </dependency>

# 2.配置knifeconfig #

package com.test.mybatisplus.config;
    
    import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Import;
    import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import springfox.documentation.service.Contact;
    /**
     * @Description:集成knife4j实现风格化API文档
     * * @param null
     * @Return:
     * @Author: hf
     * @Time: 2021/2/22 17:03
     */
    @Configuration
    @EnableSwagger2
    @EnableKnife4j
    @Import(BeanValidatorPluginsConfiguration.class)
    public class Knife4jConfig {
    
        @Bean(value = "defaultApi2")
        public Docket defaultApi2() {
            Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                    .select()
                    // 这里指定Controller扫描包路径
                    .apis(RequestHandlerSelectors.basePackage(
                            "com.test.mybatisplus.knife4jcontroller"))
                    .paths(PathSelectors.any()).build();
            return docket;
        }
    
        private ApiInfo apiInfo() {
            Contact contact = new Contact("kry", "", "");
            return new ApiInfoBuilder().title("knife测试").
                    description("knife测试描述").contact(contact).version("1.0.0").build();
        }
    }

# 鼠标处可自定义扫描路径 #

# ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70][] #

# 3.Knife4jTsetController #

package com.test.mybatisplus.knife4jcontroller;
    
    import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
    import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
    import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
    import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
    import com.baomidou.mybatisplus.core.metadata.IPage;
    import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
    import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
    import com.test.mybatisplus.entity.PressInfoEntity;
    import com.test.mybatisplus.service.PressInfoService;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiParam;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.*;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.util.*;
    
    
    /**
     * @Description mybatis-plus 通用curd测试
     * @project xr
     * @author：hf
     * @date：
     * @company:人生有限公司
     */
    @Api(tags="Knife4jTsetController")
    @RestController
    @RequestMapping("knife")
    @Slf4j
    public class Knife4jTsetController {
     
        @ApiOperation(value = "测试index接口", nickname = "测试IndexController的index接口")
        @GetMapping("/index")
        public String index() {
            return "测试IndexController的index接口...";
        }
    
    
    }

# 4.启动项目 请求[http://localhost:8084/mybatisplus//doc.html\#/home][http_localhost_8084_mybatisplus_doc.html_home] #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1][]

[20210222175918649.png]: /images/20221024/e57a8808958b4a1cb4ba609ac6dd75a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70]: /images/20221024/11990655cea54d51bb57f787c80520b9.png
[http_localhost_8084_mybatisplus_doc.html_home]: http://localhost:8084/mybatisplus//doc.html#/home
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NpbmF0XzM0MzM4MTYy_size_16_color_FFFFFF_t_70 1]: /images/20221024/eab730fde589402ba75d2c7d97c23ee2.png