SpringBoot使用SpringDoc+OpenAPI3.0实现接口文档自动生成

<dependency>
<groupId>org.springdocgroupId>
<artifactId>springdoc-openapi-uiartifactId>
<version>1.7.0version>
<dependency>

<dependency>
<groupId>org.springdocgroupId>
<artifactId>springdoc-openapi-starter-webmvc-uiartifactId>
<version>2.2.0version>
<dependency>

http://localhost:8080/swagger-ui.html

importio.swagger.v3.oas.models.OpenAPI;
importio.swagger.v3.oas.models.info.Contact;
importio.swagger.v3.oas.models.info.Info;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
@Configuration
publicclassSpringDocConfig{
@Bean
publicOpenAPIspringShopOpenAPI(){
returnnewOpenAPI()
info(newInfo()
title("SpringBoot 实战项目 API 文档")
description("接口文档自动生成 | 在线调试")
version("v1.0.0")
name("后端开发")
email("developer@demo.com")
)
);
}
}

importio.swagger.v3.oas.annotations.Operation;
importio.swagger.v3.oas.annotations.tags.Tag;
@RestController
@RequestMapping("/user")
@Tag(name ="用户管理模块", description ="用户增删改查接口")
publicclassUserController{
@Operation(summary ="根据ID查询用户", description ="传入用户ID，返回用户详情")
@GetMapping("/{id}")
publicResult<User>getUserById(@PathVariableInteger id){
returnResult.success();
}
}

importio.swagger.v3.oas.annotations.media.Schema;
@Data
@Schema(description ="用户信息实体")
publicclassUser{
@Schema(description ="用户ID", example ="1001")
privateInteger id;
@Schema(description ="用户名", example ="zhangsan")
privateString username;
}

@Operation(hidden =true)
@GetMapping("/test")
publicStringtest(){
return"test";
}

springdoc:
  api-docs:
enabled:true# 是否开启接口文档（生产设为false）
path: /v3/api-docs  # 文档JSON地址
  swagger-ui:
enabled:true# 是否开启UI页面
path: /swagger-ui.html  # 访问路径
tags-sorter: alpha  # 按字母排序
operations-sorter: alpha  # 接口排序
packages-to-scan: com.demo.controller  # 只扫描Controller包

springdoc.api-docs.enabled=false
springdoc.swagger-ui.enabled=false

@Bean
publicOpenAPIopenAPI(){
returnnewOpenAPI()
.info(newInfo()
title("API文档")
version("v1.0")
)
// 添加全局Token请求头
components(newComponents()
addSecuritySchemes("token",
newSecurityScheme()
type(SecurityScheme.Type.APIKEY)
in(SecurityScheme.In.HEADER)
name("token")
)
);
}