大网数据广告活动
Azure 网站与应用

使用 Azure API 管理向 OpenAPI 公开函数

· 52CE 我爱测

创建一个 OpenAPI 定义,使其他应用和服务可以在 Azure 中调用函数。

通常使用 OpenAPI 定义描述 REST API。 此定义中包含的信息涉及 API 中哪些操作可用,以及 API 的请求和响应数据应采用怎样的结构。

本教程将创建确定风力涡轮机上的紧急修复是否经济高效的函数。 然后使用 Azure API 管理为该函数应用创建一个 OpenAPI 定义,使该函数可使用其他应用和服务进行调用。

在本教程中,你将了解如何执行以下操作:

  • 在 Azure 中创建一个函数
  • 使用 Azure API 管理生成 OpenAPI 定义
  • 通过调用函数测试定义
  • 下载 OpenAPI 定义

创建函数应用

必须使用 Function App 托管函数的执行。 函数应用可将函数分组为逻辑单元,以便更轻松地管理、部署、缩放和共享资源。

  1. 在 Azure 门户菜单或“主页”页中,选择“创建资源” 。

  2. 在 “新建” 页面,选择 “计算” > “函数应用” 。

  3. 在“基本信息”页上,使用下表中指定的函数应用设置。

    设置 建议的值 说明
    订阅 你的订阅 要在其下创建此新函数应用的订阅。
    资源组 myResourceGroup 要在其中创建 Function App 的新资源组的名称。
    函数应用名称 全局唯一名称 用于标识新 Function App 的名称。 有效字符为 a-z(不区分大小写)、0-9 和 -。
    <bpt id="p1"></bpt>Publish<ept id="p1"></ept> 代码 用于发布代码文件或 Docker 容器的选项。
    运行时堆栈 首选语言 选择支持你喜欢的函数编程语言的运行时。 门户中编辑仅适用于 JavaScript、PowerShell、TypeScript 和 C# 脚本。 C# 类库、Java 和 Python 函数必须在本地开发。
    版本 版本号 选择已安装的运行时的版本。
    区域 首选区域 选择离你近或离函数访问的其他服务近的区域。
  4. 选择“下一步: 托管”。 在“托管”页上,输入以下设置。

    设置 建议的值 说明
    存储帐户 全局唯一名称 创建函数应用使用的存储帐户。 存储帐户名称必须为 3 到 24 个字符,并且只能包含数字和小写字母。 也可使用现有帐户,但该帐户必须符合存储帐户要求。
    操作系统 Windows 系统会根据你的运行时堆栈选择为你预先选择一个操作系统,但你可以根据需要更改该设置。 仅在 Windows 上支持门户内编辑。
    计划 消耗(无服务器) 定义如何将资源分配给 Function App 的托管计划。 在默认的 消耗 计划中,根据函数需求动态添加资源。 在此无服务器托管中,只需为函数运行时间付费。 按应用服务计划运行时,必须管理函数应用的缩放。
  5. 选择“下一步: 监视”。 在“监视”页上,输入以下设置。

    设置 建议的值 说明
    Application Insights 默认 在最近的受支持的区域中,创建一个具有相同应用名称的 Application Insights 资源。 通过展开此设置或选择“新建”,可以更改 Application Insights 名称或在 Azure 地理位置中选择要存储数据的其他区域。
  6. 选择“查看 + 创建”,以便查看应用配置选择。

  7. 在“查看 + 创建”页上查看设置,然后选择“创建”来预配并部署函数应用 。

  8. 选择门户右上角的“通知”图标,留意是否显示了“部署成功”消息。

  9. 选择“转到资源”,查看新的函数应用。 还可选择“固定到仪表板”。 固定可以更轻松地从仪表板返回此函数应用资源。

    部署通知

创建函数

本教程使用 HTTP 触发的函数,该函数采用两个参数:

  • 预计进行涡轮机修复的时间,以小时为单位。
  • 涡轮机的容量,以千瓦为单位。

然后函数计算修复的费用和涡轮机 24 小时可以产生的收入。 要在 Azure 门户中创建 HTTP 触发的函数,请执行以下步骤:

  1. 从函数应用的左侧菜单中选择“函数”,然后从顶部菜单中选择“添加”。

  2. 在“新建函数”窗口中,选择“Http 触发器”。

  3. 对于“新函数”,请输入 TurbineRepair。

  4. 从授权级别下拉列表中选择“函数”,然后选择“创建函数”。

    创建用于 OpenAPI 的 HTTP 函数

  5. 选择“代码 + 测试”,然后从下拉列表中选择“run.csx”。 将 run.csx C# 脚本文件的内容替换为以下代码,然后选择“保存”:

    #r &quot;Newtonsoft.Json"
    
    using System.Net;
    using Microsoft.AspNetCore.Mvc;
    using Microsoft.Extensions.Primitives;
    using Newtonsoft.Json;
    
    const double revenuePerkW = 0.12;
    const double technicianCost = 250;
    const double turbineCost = 100;
    
    public static async Task<IActionResult> Run(HttpRequest req, ILogger log)
    {
        // Get query strings if they exist
        int tempVal;
        int? hours = Int32.TryParse(req.Query["hours"], out tempVal) ? tempVal : (int?)null;
        int? capacity = Int32.TryParse(req.Query["capacity"], out tempVal) ? tempVal : (int?)null;
    
        // Get request body
        string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
        dynamic data = JsonConvert.DeserializeObject(requestBody);
    
        // Use request body if a query was not sent
        capacity = capacity ?? data?.capacity;
        hours = hours ?? data?.hours;
    
        // Return bad request if capacity or hours are not passed in
        if (capacity == null || hours == null){
            return new BadRequestObjectResult("Please pass capacity and hours on the query string or in the request body");
        }
        // Formulas to calculate revenue and cost
        double? revenueOpportunity = capacity * revenuePerkW * 24;  
        double? costToFix = (hours * technicianCost) +  turbineCost;
        string repairTurbine;
    
        if (revenueOpportunity > costToFix){
            repairTurbine = "Yes";
        }
        else {
            repairTurbine = "No";
        };
    
        return (ActionResult)new OkObjectResult(new{
            message = repairTurbine,
            revenueOpportunity = "$"+ revenueOpportunity,
            costToFix = "$"+ costToFix
        });
    }
    

    此函数代码会返回 Yes 或 No 消息,指示紧急修复是否具有成本效益。 它还返回涡轮机所代表的收入机会和修复涡轮机的成本。

  6. 若要测试此函数,请选择“测试”,接着选择“输入”选项卡,输入以下输入作为“正文”,然后选择“运行”:

    {
    "hours": "6",
    "capacity": "2500"
    }
    

    创建用于 OpenAPI 的 HTTP 函数

  7. 选择“代码 + 测试”,然后从下拉列表中选择“run.csx”。 将 run.csx C# 脚本文件的内容替换为以下代码,然后选择“保存”:

    #r &quot;Newtonsoft.Json":::
    
    “输出”选项卡中会返回以下输出:
    
    ```json
    {"message":"Yes","revenueOpportunity":"$7200","costToFix":"$1600"}
    

现在已经有了确定紧急修复是否经济高效的函数。 接下来,为该函数应用生成 OpenAPI 定义。

生成 OpenAPI 定义

若要生成 OpenAPI 定义,请执行以下操作:

  1. 选择该函数应用,从左侧菜单中选择“API 管理”,然后在“API 管理”下选择“新建”。

    创建用于 OpenAPI 的 HTTP 函数

  2. 选择“代码 + 测试”,然后从下拉列表中选择“run.csx”。 将 run.csx C# 脚本文件的内容替换为以下代码,然后选择“保存”:

    #r &quot;Newtonsoft.Json":::
    
    
    
  3. 使用下表中指定的“API 管理”设置:

    设置 建议的值 说明
    名称 全局唯一名称 根据函数应用的名称生成一个名称。
    订阅 订阅 在其下创建此新资源的订阅。
    资源组 myResourceGroup 与函数应用相同的资源,系统会为你设置。
    位置 美国西部 选择“美国西部”位置。
    组织名称 Contoso 在开发人员门户中使用的组织名称,也用于电子邮件通知。
    管理员电子邮件 你的电子邮件 从 API 管理接收了系统通知的电子邮件。
    定价层 消耗 消耗层并非在所有区域中均可用。 如需完整的定价详细信息,请参阅 API 管理定价页

    创建新的 API 管理服务

  4. 选择“创建”以创建 API 管理实例,这可能需要几分钟的时间。

  5. Azure 创建该实例后,它会在页面上启用“启用 Application Insights”选项。 选择该选项以将日志发送到函数应用程序所在的位置,然后选择“链接 API”。

  6. 此时会打开“导入 Azure Functions”,其中突出显示了“TurbineRepair”函数。 选择“选择”,继续操作。

    将 Azure Functions 导入 API 管理

  7. 在“从函数应用创建”页中接受默认值,然后选择“创建”。

    创建用于 OpenAPI 的 HTTP 函数

  8. 选择“代码 + 测试”,然后从下拉列表中选择“run.csx”。 将 run.csx C# 脚本文件的内容替换为以下代码,然后选择“保存”:

    #r &quot;Newtonsoft.Json":::
    
    Azure 会创建用于该函数的 API。
    
    

测试 API

在使用 OpenAPI 定义之前,应验证 API 是否可以正常工作。

  1. 在函数应用页上,依次选择“API 管理”、“测试”选项卡和“POST TurbineRepair”。

  2. 在“请求正文”中输入以下代码:

    {
    "hours": "6",
    "capacity": "2500"
    }
    
  3. 选择“发送”,然后查看“HTTP 响应”。

    创建用于 OpenAPI 的 HTTP 函数

  4. 选择“代码 + 测试”,然后从下拉列表中选择“run.csx”。 将 run.csx C# 脚本文件的内容替换为以下代码,然后选择“保存”:

    #r &quot;Newtonsoft.Json":::
    
    

下载 OpenAPI 定义

如果 API 可按预期方式工作,则你可以下载 OpenAPI 定义。

  1. 选择页面顶部的“下载 OpenAPI 定义”。

    下载 OpenAPI 定义

  2. 保存下载的 JSON 文件,然后将其打开。 查看定义。

清理资源

在前面的步骤中,你在资源组中创建了 Azure 资源。 如果将来不再需要这些资源,可以通过删除资源组来删除它们。

从 Azure 门户菜单或“主页”页上,选择“资源组” 。 然后,在“资源组”页上,选择“myResourceGroup” 。

在“myResourceGroup”页中,确保列出的资源是要删除的资源。

选择“删除资源组” ,在文本框中键入“myResourceGroup” 以确认,然后选择“删除” 。

后续步骤

你已使用 API 管理集成生成了函数的 OpenAPI 定义。 现在,可以在门户上的“API 管理”中编辑定义。 还可以详细了解 API 管理。

在 API 管理中编辑 OpenAPI 定义

历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。

资料来源与适用范围

资料来源
Microsoft / Azure 中文运维文档历史快照
适用范围
历史中文快照 2022-08-12;详见原文产品版本;文档日期 04/21/2020
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。