使用OpenAPI Maven插件生成API文档 [英] Generate API Docs with OpenAPI Maven plugin

问题描述

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

我注意到Maven plugin有一个generateApiDocumentation标志 我不太确定它是做什么的。

遗憾的是，SpringFox还不支持OpenAPI 3--而且，当我只想将初始的YAML公开为json时，使用基于反射的生成器似乎毫无意义。

推荐答案

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文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！