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

时间:2015-09-18 23:33:41

标签: c# api azure swagger

我正在运行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#

1 个答案:

答案 0 :(得分:1)

目前有两个Nuget包 -

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

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

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

“您的根-URL”/昂首阔步/文档/ V1

“您的根-URL”/昂首阔步

以下是github页面,供您完整参考此项目: https://github.com/domaindrivendev/Swashbuckle