如何在 Azure Easy API 中启用 Swagger UI答案

【问题标题】：How to enable Swagger UI in Azure Easy API如何在 Azure Easy API 中启用 Swagger UI
【发布时间】：2019-09-25 11:31:16
【问题描述】：

我正在使用 Azure 应用服务，并为我的移动设备的 API 后端设置了带有 Easy Table 的 Easy API。

我想知道如何为 Azure 应用服务设置 Swagger UI。

当我尝试导航到 API（例如https://xxxxxx.azurewebsites.net/swagger/ui）时，它指出“要访问 swagger UI，您必须通过添加 swagger: true 到您的配置并安装 swagger-ui npm 模块来启用 swagger 支持"

当您没有 API 的源代码（它是使用 Easy API 自动创建的）时，如何准确添加 swagger-ui npm？

【问题讨论】：

标签： node.js azure swagger azure-mobile-services swagger-ui

【解决方案1】：

你的问题分为两部分：

1) 目前无法在 EasyAPI 上启用 Swagger。也就是说，我们不合并也不生成 EasyAPI 的 Swagger，因为所有参数都在代码中定义。

2) 如果要启用 Swagger，则需要在 API 上方的 app.js 文件中为 Azure 移动应用的初始化程序添加“swagger: true”。进入 Easy API 或 Easy Tables 并编辑任何 API/表。这将调出编辑器。转到上面的目录（包含 api 和 tables 目录的目录）并在那里编辑 app.js 文件。

【讨论】：

我在 app.js 中添加了 swagger: true ，但是使用上面的 url 来招摇会产生相同的结果。我想知道我们是否需要添加 swagger-ui npm，因为它不在 node_module 文件夹中？
@daniel 是的，您可以通过 Git 存储库部署模块，或者在应用服务编辑器上运行 npm install commond。详情可以参考azure.microsoft.com/en-us/documentation/articles/…。
将git仓库克隆到本地并在package.json中添加swagger-ui后，就可以运行swagger了。谢谢！
@daniel 你是怎么做到的，你能显示完整的包文件

【解决方案2】：

步骤：

在门户 Azure 上
打开您的应用程序应用服务
转到开发工具 -> 应用服务编辑器（预览版） - 单击开始
Inside App Service Editor (Preview) -> 打开Console (CTRL + Shift + C)
键入 npm install --save swagger-ui
等待安装
如果 node_modules 上存在文件夹，请检查安装 -> swagger-ui
现在在应用程序文件 /wwwroot/app.js 上启用 swagger

更改内容：

var mobile = azureMobileApps({ // 显式启用 Azure 移动应用主页主页：是的，

// Explicitly enable swagger support. UI support is enabled by
// installing the swagger-ui npm module.
swagger: true

});

在 Google Chrome 上的 https://your-application.azurewebsites.net 上测试 Swagger 点击试用或打开 https://your-application.azurewebsites.net/swagger/ui

【讨论】：