【Java】API接口文档宝典（knife4j）

汝之观览，吾之幸也！本文主要讲解swagger3的使用，方便开发者更好的测试接口，也可在对接第三方时更快速地导出api文档。
swagger官网地址，Knife4j官网地址

作用

使用Swagger开源和专业工具集简化用户、团队和企业的API开发。了解Swagger如何帮助您大规模设计和记录API。

导入依赖

因为knife4j包含swagger3，所以只引入knife4j即可

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

新增配置类

新增Swagger3Config

@Configuration
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Java学习")
                .description("纯码农公众号版权所有")
                .contact(new Contact("mitool", "", ""))
                .version("1.0")
                .build();
    }

}

实际使用

使用测试类 TestController 进行测试

@Api(value = "测试api", tags = {"测试api"})
@RestController
@RequestMapping("/test")
public class TestController {

    @ApiOperation(value = "方法说明")
    @GetMapping("/testMethod")
    public Map<String, Object> testMethod() {
        Map<String, Object> resultMap = new HashMap<>(2);
        resultMap.put("code", 200);
        resultMap.put("msg", "调用成功！");
        return resultMap;
    }
}

启动项目后根据配置的port与context-path得到地址
swagger地址