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

我希望能为您提供帮助。

Answer 2

https://springdoc.org/faq.html

设置 Swagger UI 以使用提供的 spec.yml 的正确方法是什么？

使用此属性，所有 springdoc-openapi 自动配置 bean 都被禁用：

springdoc.api-docs.enabled=false

然后通过添加这个Bean来启用最小bean配置：

@Bean
SpringDocConfiguration springDocConfiguration(){
   return new SpringDocConfiguration();
}
@Bean
public SpringDocConfigProperties springDocConfigProperties() {
   return new SpringDocConfigProperties();
}

然后配置自定义 UI yaml 文件的路径。

springdoc.swagger-ui.url=/my-api-docs.yaml

在这种情况下，您应该将 'my-api-docs.yaml' 放入 'src/main/resources/static/' 文件夹！

使用OpenAPI Maven插件生成API文档

2 个答案: