是否有任何理由仅使用swagger / docs / v1以JSON格式生成swagger元数据

时间:2016-12-06 10:11:32

标签: swagger swagger-ui swashbuckle azure-api-apps

我目前正在开发Azure API App服务,因为我对使用swashbuckler生成swagger元数据有点困惑。为此,我阅读了以下文档,他们提到要查看您的元数据,只需在API网址末尾添加swagger / docs / v1。

https://docs.microsoft.com/en-us/azure/app-service-api/app-service-api-dotnet-get-started

我也做了同样的事情,我能够以JSON的形式看到我的元数据生成。但是当我在API网址的末尾添加了swagger / help / v1或swagger / help / v2时,我没有获得JSON格式的任何元数据。

是否有任何理由仅使用swagger / docs / v1以JSON格式生成swagger元数据,或者允许使用swagger / help / v1等其他元素。

1 个答案:

答案 0 :(得分:4)

Swashbuckle的默认路径是/ swagger / docs / v1和Swashbuckle docs show how to change that path

httpConfiguration
    .EnableSwagger("docs/help/{apiVersion}", c => c.SingleApiVersion("v1", "A title for your API"))
    .EnableSwaggerUi("sandbox/{*assetPath}");

在这种情况下,swagger json的网址为docs/help/v1,swagger-ui的网址为sandbox/index