使用 OpenAPI Maven 插件生成 API 文档

Question

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

我注意到Maven 插件有一个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

我希望我能帮助你。