将 Swagger 文件添加到 Swashbuckle
Add Swagger File to Swashbuckle
我目前正在使用 Swashbuckle 来记录我的 .Net API,这是一个很棒的工具。我想知道我是否可以添加存储在我的项目中的其他 swagger 文件。
我从 swashbuckle 文档中看到了以下代码并进行了尝试,但它似乎不起作用:
.EnableSwagger("docs/{apiVersion}/swagger", c => c.SingleApiVersion("v1", "A title for your API"))
.EnableSwaggerUi("sandbox/{*assetPath}");
总体目标是必须选择使用我生成的项目 XML 文件中的 swagger,并能够将其他 swagger 文件添加到要显示的配置中。
提前致谢!
默认情况下,SwashBuckle 公开当前 Web API 项目中动态生成的文件。
要能够添加其他文件,最简单的方法是:
覆盖 Swashbuckle 行为以加载 your own index.html page、
获取 original index page to modify it; notice the line 49 验证数组中的 urls。
在这里您可以将其更新为生成文件的默认值 url(例如 swagger/docs/v1
)并添加您的 Swagger 文件,您最终会得到一个与此类似的 js 数组:
discoveryPaths: arrayFrom('swagger/docs/v1|mySwaggerFiles/swaggerService.json'),
我目前正在使用 Swashbuckle 来记录我的 .Net API,这是一个很棒的工具。我想知道我是否可以添加存储在我的项目中的其他 swagger 文件。
我从 swashbuckle 文档中看到了以下代码并进行了尝试,但它似乎不起作用:
.EnableSwagger("docs/{apiVersion}/swagger", c => c.SingleApiVersion("v1", "A title for your API"))
.EnableSwaggerUi("sandbox/{*assetPath}");
总体目标是必须选择使用我生成的项目 XML 文件中的 swagger,并能够将其他 swagger 文件添加到要显示的配置中。
提前致谢!
默认情况下,SwashBuckle 公开当前 Web API 项目中动态生成的文件。
要能够添加其他文件,最简单的方法是:
覆盖 Swashbuckle 行为以加载 your own index.html page、
获取 original index page to modify it; notice the line 49 验证数组中的 urls。
在这里您可以将其更新为生成文件的默认值 url(例如 swagger/docs/v1
)并添加您的 Swagger 文件,您最终会得到一个与此类似的 js 数组:
discoveryPaths: arrayFrom('swagger/docs/v1|mySwaggerFiles/swaggerService.json'),