【问题标题】:Autogenerate OpenAPI documentation with Azure Functions使用 Azure Functions 自动生成 OpenAPI 文档
【发布时间】:2021-12-21 23:25:53
【问题描述】:

是否可以使用 Azure Functions 自动生成 OpenAPI 文档,例如就像将 Swashbuckle 与 ASP .NET Core 一起使用时如何使用 SwaggerGen ?文档应包含不同的端点及其可能的输入和响应模型以及状态代码。如果我可以在 web ui 中查看文档,那就太棒了。

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

  1. Azure Functions 的 Swashbuckle 适配:https://github.com/vitalybibikov/AzureExtensions.Swashbuckle
  2. 来自 Microsoft 的官方 OpenAPI 扩展:https://github.com/Azure/azure-functions-openapi-extension

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

对于第二个,根本没有自动检测。一切都只适用于属性。此外,该软件包仍处于预览阶段。

【问题讨论】:

  • "可能的响应代码必须通过几个函数的属性手动设置。"服务不是这样吗

标签: c# .net azure-functions swagger openapi


【解决方案1】:

根据微软官方doc,现在不是预览版,您可以通过使用在 Azure Functions 上启用 OpenAPI Endpoints

In-Process Model 和 仅限Out-of-Process Model

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

【讨论】:

  • 这应该是评论,而不是答案(它只是链接,并不是真正的答案)。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2020-04-02
  • 2019-06-19
  • 1970-01-01
  • 2022-11-02
  • 1970-01-01
  • 2020-11-07
  • 2015-06-02
相关资源
最近更新 更多