Swagger2 在线接口文档

1. 依赖包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- Swagger2 在线接口文档 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.5.0</version>
</dependency>

2. Knife4jConfiguration

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

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    @Bean(value = "dockerBeanAdmin")
    public Docket dockerBeanAdmin() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(commonApiInfo())
                //分组名称
                .groupName("后台接口分组")
                .select()
                // 这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.jeesite.modules.bpm.web"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    @Bean(value = "dockerBeanFront")
    public Docket dockerBeanFront() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(commonApiInfo())
                //分组名称
                .groupName("前台接口分组")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.jeesite.modules.bpm.web"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    private ApiInfo commonApiInfo() {
        return new ApiInfoBuilder()
                .title("XXX API")
                .description("Knife4j是一款基于Swagger的API文档在线编辑工具，它为Java开发人员提供了一种简单而强大的方式来创建、编辑和管理API文档。Knife4j可以帮助开发人员快速生成和展示API文档，提供了友好的界面和丰富的功能，包括接口测试、在线调试、文档管理等。它还支持对Swagger注解的解析，能够自动生成API文档，并提供了一些扩展功能，如接口权限设置、数据模型展示等。Knife4j可以帮助开发团队更好地管理和维护API文档，提高开发效率和协作能力。")
                .contact("hwike@foxmail.com")
                .version("1.0")
                .build();
    }
}

3. Controller

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Api(value = "流程设计图 AIP接口", tags = "流程设计图 AIP接口")
@Slf4j
@RestController
@RequestMapping("/bpmActModel")
public class BpmActModelController {

    @ApiOperation("导出流程图设计节点角色人员")
	@PostMapping("/xxx")
	public ResponseApiData<XxxResponse> xxx(@Validated @RequestBody XxxRequest request) {
        // TODO
    }       
}

4. API 调试页面

http://localhost:端口号/上下文/doc.html