spring - 使用 OpenAPI Maven 插件生成 API 文档

Question

我正在尝试为从 OpenAPI 3 yaml 生成的 Spring REST 应用程序生成 API 文档端点(例如 /v3/api-docs )。

我注意到 Maven plugin有一个 generateApiDocumentation旗帜，虽然
我不确定它的作用。

不幸的是SpringFox尚不支持 OpenAPI 3——而且当我想要做的只是将初始 yaml 公开为 json 时，拥有基于反射的生成器似乎毫无意义。

Answer 1

我不确定是否理解您的问题，但可以尝试查看这篇文章:https://www.baeldung.com/spring-rest-openapi-documentation

您也可以查看文档 https://github.com/springdoc/springdoc-openapi

基本上你只需要添加这个 maven 依赖

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

之后，当您启动服务时，您可以使用以下路径检查您的主机:/swagger-ui.html 格式如下:

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

我希望我会帮助你。