SpringDoc
图
使用SpringDoc,您可以轻松地为Spring Boot RESTful API生成OpenAPI文档。只需在您的代码中添加一些注解,SpringDoc就会自动扫描您的代码并生成OpenAPI文档。这对于许多需要使用OpenAPI的应用程序非常有用,例如API文档、客户端代码生成和测试集成等

说明

接口文档工具,与swagger类似,查看官方文档

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.15</version>
</dependency>

注解

@Tag:用在类上,设置Controller的名称和描述

@Operation:用在方法上,设置接口的名称和描述,如:

@Operation(summary = "测试", description = "此接口用于测试")

@Schema:用在请求、响应的实体类中,类和属性都可以

访问

# swagger-ui custom path 可自定义,以下为默认
springdoc.swagger-ui.path=/swagger-ui.html