我如何将 Swagger 添加到我的 Azure 云服务工作者角色

Question

我有一个 Azure 云服务（工作者角色）运行。此辅助角色使用 WebHttpBinding 绑定公开 Web 端点。它使用 WebInvoke 公开多个 REST 端点。

示例：

[OperationContract]
[WebInvoke(UriTemplate = "/Test",
    Method = "GET",
    RequestFormat = WebMessageFormat.Json,
    ResponseFormat = WebMessageFormat.Json)]
bool Test();

我需要在哪里或如何开始将 Swagger UI 添加到我的项目中，以便外部开发人员可以在我的 API 上查看文档？

感谢任何帮助。我正在使用 .NET 4.5.2 和 C#

Answer 1

目前有两个 Nuget 包 -

核心库 (Swashbuckle.Core) 和提供自动引导的便利包 (Swashbuckle)。

后者仅适用于常规 IIS 托管的 WepApi。对于所有其他托管环境，您应该只安装核心库，然后按照以下说明手动启用 Swagger 路由。

安装并启用后，您应该能够分别浏览以下 Swagger 文档和 UI 端点：

"your-root-url"/swagger/docs/v1

"your-root-url"/大摇大摆

这里是 github 页面供您完整参考该项目： https://github.com/domaindrivendev/Swashbuckle

我如何将 Swagger 添加到我的 Azure 云服务工作者角色

How would I add Swagger to my Azure cloud service worker role

c#

api

azure

swagger