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

【问题标题】：Is there any reason using only swagger/docs/v1 for generating swagger metadata in the form JSON是否有任何理由仅使用 swagger/docs/v1 以 JSON 格式生成 swagger 元数据
【发布时间】：2016-12-06 10:11:32
【问题描述】：

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

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

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

是否有任何理由仅使用 swagger/docs/v1 来生成 JSON 格式的 swagger 元数据或其他也允许的形式，如 swagger/help/v1 等。

【问题讨论】：

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

【解决方案1】：

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 的 URL 将是 docs/help/v1，swagger-ui 的 URL 将是 sandbox/index。

【讨论】：