SpringBoot集成knife4j生成API文档

pom文件导包

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

创建配置文件

package com.minglei.optimistic_lock_demo_two.config;

import io.swagger.annotations.ApiOperation;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * @Author: 薛定谔的英短
 * @Date: 2020/12/22 10:10
 * @mail: 18612371148@163.com
 */
@Configuration
@EnableSwagger2WebMvc
public class knife4jConfiguration {
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("薛定谔的英短")
                        .description("测试接口文档")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("xx@qq.com")
                        .version("1.0")
                        .build())
                //分组名称
//                .groupName("2.X版本")
                .select()
                //指定扫描注解
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //这里指定Controller扫描包路径
//                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

用法（控制器）

package com.minglei.optimistic_lock_demo_two.controller;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.github.xiaoymin.knife4j.annotations.DynamicParameter;
import com.github.xiaoymin.knife4j.annotations.DynamicParameters;
import com.minglei.optimistic_lock_demo_two.dao.goodsDao;
import com.minglei.optimistic_lock_demo_two.dto.goods.goodsUpdateDto;
import com.minglei.optimistic_lock_demo_two.entity.goodsEntity;
import com.minglei.optimistic_lock_demo_two.exceptionCustom.retryException;
import com.minglei.optimistic_lock_demo_two.service.goodsService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.List;

/**
 * @Author: 薛定谔的英短
 * @Date: 2020/12/7 17:52
 * @mail: 18612371148@163.com
 */
@RestController
@RequestMapping("test")
@Api(tags = "测试knife4j")
public class TestController {

    @Autowired
    goodsDao goodsDao;

    @Autowired
    goodsService goodsService;

    @PostMapping("hello")
    @ApiOperation("下单接口")
   @ApiImplicitParams({
           @ApiImplicitParam(name = "orderNo",value = "单号",dataType = "string")
   })
    public String hello(@RequestBody HashMap param) throws retryException {
        QueryWrapper<goodsEntity> wrapper=new QueryWrapper<>();
        wrapper.eq("id",1);
        goodsEntity goodsEntity = goodsDao.selectOne(wrapper);


        goodsUpdateDto params=new goodsUpdateDto();
        params.setId(1);
        params.setStock(10);
        params.setVersion(goodsEntity.getVersion());
        Integer integer = goodsService.buyGoods(params);
        System.out.println("结果是："+integer);
        if(integer>0){
            return "下单成功";
        }else {
            return  "下单失败";
        }

    }
}

效果图

最新项目结构

PS:该功能与乐观锁模拟下单项目是一个项目，只是新增了个API文档功能
详情点击查看模拟乐观锁博客→完整spring boot项目实现乐观锁+重试机制 模拟下单

knife官方文档地址：官方文档地址