springdoc-openapi 的基本使用

最新推荐文章于 2025-06-18 15:00:17 发布

程序猿小乙

最新推荐文章于 2025-06-18 15:00:17 发布

阅读量1k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： java 文章标签： java 开发语言

本文链接：https://blog.csdn.net/csdn_manong1/article/details/130358864

java 专栏收录该内容

28 篇文章

订阅专栏

文章介绍了如何利用springdoc-openapi为springboot项目快速创建规范的API文档，包括添加依赖、配置信息、注解方法以及查看生成的文档。相较于springfox，springdoc-openapi具有更好的Spring兼容性和活跃的社区支持，更符合OpenAPI3规范。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

概述

使用 springdoc-openapi 可以快速为 springboot 项目生成规范的 API 文档，具体使用步骤如下：

依赖配置

在 pom.xml 加入内容，即可开始使用：

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

然后在 Config 中配置基本的描述信息，如下：

@Configuration
public class OpenApiConfig {

    @Bean
    public OpenAPI springOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("SpringDoc API Test")
                        .description("SpringDoc Simple Application Test")
                        .version("0.0.1"));
    }

}

接下来在 Controller 中使用注解标记文本，如下：

@RestController(value = "/clients")
@Tag(name = "/clients")
public class ClientsRestController {

    @Operation(summary = "This method is used to get the clients.")
    @GetMapping
    public List<String> getClients() {
        return Arrays.asList("First Client", "Second Client");
    }
}

最后 Application.java 启动应用后，输入默认地址：http://localhost:8081/swagger-ui/index.html 即可看到文档：