我有一个使用Web API 2的网站,我正在使用Swashbuckle Swagger生成API文档并导出Azure API管理的JSON配置。在我的场景中,如果 API 可以按 Swagger 文档 URL (http://example.com/swagger/{my-api-group}( 中定义的值进行分组,那将是理想的选择。但是,经过一些研究,我找不到实现它的方法。
据我所知,目前为了让我更改 Swagger 导出文件,每次有更改时我都需要重新启动环境,这在我的场景中并不理想。
我试图看看我是否可以从NuGet包中获取开源代码,看看我是否可以理解Swashbuckle的内部工作原理。此外,我知道这可以使用"Swashbuckle.AspNetCore"来实现,但这不是一个选项,因为我正在将此功能集成到一个大型的.NET Framework解决方案中,这将是一项艰巨的任务。
是的,你可以这样做,这里有一个例子:
http://swagger-net-test-multiapiversions.azurewebsites.net/swagger/ui/index
在这里:
https://github.com/heldersepu/Swagger-Net-Test/tree/MultiApiVersions
关键是配置上的这一部分:
// If your API has multiple versions, use "MultipleApiVersions" instead of "SingleApiVersion".
// In this case, you must provide a lambda that tells Swagger-Net which actions should be
// included in the docs for a given API version. Like "SingleApiVersion", each call to "Version"
// returns an "Info" builder so you can provide additional metadata per API version.
//
c.MultipleApiVersions(
(apiDesc, targetApiVersion) => targetApiVersion.Equals("default", StringComparison.InvariantCultureIgnoreCase) ||
apiDesc.Route.RouteTemplate.StartsWith(targetApiVersion, StringComparison.InvariantCultureIgnoreCase),
(vc) =>
{
vc.Version("default", "Swagger_Test");
vc.Version("v1_0", "Swagger_Test V1_0");
vc.Version("v2_0", "Swagger_Test V2_0");
});
另一种选择可能是利用最新 UI 上的过滤器:
- http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=Default
- http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=Big
- http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=Image