Azure Functions 中的 OpenAPI 2.0 元数据支持(预览版)

Azure Functions 中的 OpenAPI 2.0(以前称为 Swagger)元数据支持一项预览版功能,可用于在 Function App 中编写 OpenAPI 2.0 定义。 随后可使用 Function App 托管该文件。

Important

OpenAPI 预览功能目前仅在 1.x 运行时可用。 若要了解如何创建 1.x 函数应用,可参阅此处

通过 OpenAPI 元数据,大量其他软件可使用托管 REST API 的函数。 此软件包括 Microsoft 产品/服务(如 PowerApps 和 Azure 应用服务的 API 应用功能)、第三方开发人员工具(如 Postman,以及更多大量的程序包

此参考信息面向 Azure Functions 开发人员。 Azure Functions 的新手请从以下资源入手:

Tip

建议先从入门教程开始,然后返回到本文档,了解有关特定功能的详细信息。

启用 OpenAPI 定义支持

可在函数应用的“平台功能”的“API 定义”页中配置所有 OpenAPI 设置。

Note

beta 版本运行时当前不支持函数 API 定义功能。

要生成托管的 OpenAPI 定义和快速入门定义,请将“API 定义源”设置为“函数(预览版)”。 外部 URL 允许函数使用托管在其他位置的 OpenAPI 定义。

通过函数元数据生成 Swagger 框架

模板可帮助你开始编写第一个 OpenAPI 定义。 定义模板功能通过使用 function.json 文件中的所有元数据,为每个 HTTP 触发器函数创建稀疏的 OpenAPI 定义。 将需要按 OpenAPI 规范填写 API 详细信息,如请求和响应模板。

有关分步说明,请参阅入门教程

可用模板

Name 说明
生成的定义 一个 OpenAPI 定义,内含可从函数的现有元数据中推断出的大量信息。

生成的定义中包含的元数据

下表显示了 Azure 门户设置,并显示 function.json 在映射到生成的 Swagger 框架时包含的相应数据。

Swagger.json 门户 UI Function.json
主机 “Function App 设置” > “应用服务设置” > “概述” > “URL” 不存在
路径 “集成” > “选择 HTTP 方法” 绑定:路由
路径项 “集成” > “路由模板” 绑定:方法
安全性 密钥 不存在

Note

x-ms-summary 扩展在逻辑应用中提供显示名称。

后续步骤