手把手教你在 Azure Functions 中使用 Swagger 构建 Web API
Azure Functions 是一种事件驱动计算的服务，可以根据事件自动进行处理操作。而 Swagger 是一种 API 规范和工具，可以帮助开发者定义和构建出良好的 API。在这篇文章中，我们将教你如何在 Azure Functions 中使用 Swagger 构建 Web API。
首先，在 Azure Functions 上新建一个 HTTP trigger 类型的函数。
在新建的函数中，我们需要添加 Swagger。在此过程中，我们可以使用开源工具 Swashbuckle 来实现。在 NuGet 上搜索 Swashbuckle.AspNetCore，然后添加它。Swashbuckle 会自动添加必要的文件和代码，使得 Swagger 规范可以自动映射到 Web API 中。
现在，让我们编辑 Startup.cs 文件，从而使用 Swashbuckle 中间件注册 Swagger UI。
-- -------------------- ---- ------- ----- ----------------------------- ----- ----------------------------- ----- --------------------------------------------------------- ----- ----------------------------------------- ----- ------------------------- ----- ------- ----- ---------- ---------- ------------------------------------------------- --------- -------------- - ------ ----- ------- - ---------------- - ------ -------- ---- ------------------------------- -------- - --- -------- - ------------------------------------------------------------ - -------------- -------------------------------- -- - ------------------ --- ----------- - ----- - --- ----- ------- - ---- --- --- ------- - ------------------------------------------------- --- ------- - ---------------------- --------- ------------------------------ --- - ------ -------- ---- -------------------------------------------------------- -------- - --------------------------- ------- - --------------------- ---------------------------- ----------------------------------------- -------------------------------- --------- ----- --------------- ----- ----------------------------------------------------------- --------- ----- --------------- ----- --------------------------- - ------ -------- ---- -------------------------------- -------- - --------------------------- ------- - --------------------- ---------------------------------------------------- ------------------------------------------------------------ ------------ ------------------------------- - - -展开代码
在 SwaggerDoc 方法中，我们要填写我们自己定义的接口信息。
在 IncludeXmlComments 方法中，我们可以选择性地传入 XML 文档路径，用于提取注释信息。XML 文档可以由 Visual Studio 自动产生。在项目属性中的生成选项中可以找到“生成 XML 文档文件”的选项。
- 修改函数代码，这里我们以 C# 代码为例。
-- -------------------- ---- ------- ----- ----------- ----- ------------------------- ----- ----------------------------- ----- -------------------------- ----- ----------------------------------- --------- ----------- - ------ ------ ----- ------- - ------------------------------- ------------------------------------- ------------------------ ---------------------- - ----- - ------ -- ------- - --- ---- ----- ----------- - -- ------ ---- -------- -- -------- --- ----- --------- --------------- ------ ------ ------------- ---- ------------------------------------------ ------ ----- - ------ ----------- ---- ------- ---- - ---------------------- ---- ------- -------- --------- - ----------- ------ --- ---------------------- --------- - - -展开代码
在 SwaggerOperation 属性中，你可以填写 API 描述信息。在此处，我们填写了接口类别（Tags）、接口摘要（Summary）和接口详情描述（Description）。
- 启动 Azure Functions 服务并调用 API。
完成了以上步骤后，打开 Swagger UI 页面（例如 http://localhost:7071/swagger/index.html），就可以看到自己定义的 API 接口信息。可以通过 Swagger UI 页面直接执行 API 接口测试。
在本文中，我们详细介绍了在 Azure Functions 中使用 Swagger 构建 Web API 的方法。Azure Functions 本身具有轻量级、高效率的特点，而 Swagger 的出现可以加速项目开发的进程。对于中小型项目而言，使用 Azure Functions 和 Swagger 可以帮助项目快速实现可靠的 Web API。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67b6d338306f20b3a6323afe
