当前位置: 首页 > 知识库问答 >
问题:

使用Azure函数自动生成OpenAPI文档

冯星阑
2023-03-14

是否可以使用Azure函数自动生成OpenAPI文档,例如,在ASP中使用Swashback时,如何使用Swagggen。净核心?文档应包含不同的endpoint及其可能的输入和响应模型以及状态代码。如果我能在web ui中查看文档,那就太棒了。

目前,我发现了两个可能的方案:

  1. 针对Azure功能的虚张声势的调整:https://github.com/vitalybibikov/AzureExtensions.Swashbuckle
  2. 微软的官方OpenAPI扩展:https://github.com/Azure/azure-functions-openapi-extension

对于第一个,只能检测我的模型/DTO和不同的endpoint。但是endpoint和模型之间的关系以及可能的响应代码必须通过几个函数的属性手动设置。

对于第二个,根本没有自动检测。一切只与属性有关。此外,该软件包仍在预览中。

共有1个答案

万高轩
2023-03-14

根据微软官方文档(目前不在预览中),您可以使用

仅限进程内模型和进程外模型。

通过使用文档中提到的扩展,我们可以生成OpenAPI文档。

 类似资料:
  • 我正在开发一个Spring Boot应用程序的后端,该应用程序使用OpenAPI和Swagger通过模式为前端应用程序提供接口。yml文件。当对控制器进行更改时,我们使用swagger ui获取api文档JSON,使用在线swagger编辑器将其转换为yaml,并将结果粘贴到模式中。yml文件 现在,我想让它自动化,这样我们就可以调用一个maven任务来自动生成yaml文件,但我找不到任何mave

  • 我已经使用MongoDB启动了一个新的Spring Boot应用程序(2.2.1.RELEASE)。 为了创建一些API文档,我添加了springdoc API: 由于我依赖Spring来处理RESTendpoint的生成,因此我创建了以下简单的存储库: 所以我没有使用的类。 我试图添加一些ProfileRepository中方法的注释,但不会生成任何内容。 : 如何为Spring数据REST存储

  • 我注意到我为C#代码生成不同的文件夹结构和文件扩展名,具体取决于我是使用Azure CLI(带有.csx脚本库的文件夹)还是Visual Studio(没有带有.cs类库的文件夹)。从 CLI 进行调试只会公开 .csx 终结点,反之亦然。 有没有可能配置Azure CLI使用类库生成函数?或者让CLI和Visual Studio提供相同的调试endpoint?

  • 我在一个带注释的对象中有几个枚举,如: 其中枚举定义为: 使用Openapi3,我可以生成一个swagger文档。我的问题是,和,翻译方式不同,如: 我希望< code>Enum2与< code>Enum1一样被记录,因此具有实际的枚举值。有什么方法可以强制这样做,或者解释为什么会这样?两个枚举基本上与示例中的相同。

  • 我正在尝试在这两种语言中生成客户端代码。使用NSwag CLI的NET Core和TypeScript: 这适用于各种Swagger 2.0 JSON文件,但为OpenApi 3.0 JSON文件生成多个具有完全相同名称的函数。 我的选择。swag文件具有以下内容。NET(TypeScript以类似的方式生成,存在相同的问题): 是否有一种方法可以控制函数名的生成,以便添加一些判别式(类似于依赖于

  • 不幸的是,SpringFox还不支持OpenAPI3,而且,当我只想将最初的yaml公开为JSON时,使用基于反射的生成器似乎毫无意义。