Spring Boot 与OpenAPI:实现自动化API文档生成
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import io.swagger.v3.oas.annotations.servers.Server;
import org.springframework.context.annotation.Configuration;
@Configuration
@OpenAPIDefinition(
info = @Info(
title = "示例API文档",
version = "1.0.0",
description = "这是一个自动生成的API文档示例"
),
servers = @Server(url = "http://localhost:8080")
)
public class OpenApiConfig {
// 该类将用于配置OpenAPI的基本信息和服务器地址
}
这段代码演示了如何在Spring Boot应用程序中使用@OpenAPIDefinition
注解来配置OpenAPI的信息。在这个例子中,我们设置了API的标题、版本、描述和服务器地址。这些信息将被用于自动生成API文档,使得开发者能够快速了解如何与API交互。
评论已关闭