我正在使用Swashbuckle AspNetCore v4.x.x,然后升级到v5.1.x.x。但是由于缺少“ SwaggerContractResolver”类,我不再使用的代码。
我试图实现的目标是在我的RESTfull API的代码中生成swagger.json:
public static string GenerateSwagger(this IWebHost webhost, string docName, string basePath)
{
var sw = (ISwaggerProvider)webhost.Services.GetService(typeof(ISwaggerProvider));
var doc = sw.GetSwagger(docName, null, basePath);
var json = JsonConvert.SerializeObject(
doc,
Formatting.Indented,
new JsonSerializerSettings
{
NullValueHandling = NullValueHandling.Ignore,
ContractResolver = new SwaggerContractResolver(new JsonSerializerSettings())
}
);
return json;
}
string json = GenerateSwagger(webhost, docName, url);
string path = Path.Combine(path, docName);
File.WriteAllText(path + ".json", json);
如何使用新版本的Swashbuckle AspnetCore像v4一样执行此操作?
答案 0 :(得分:1)
使用Swashbuckle V5,您可以使用.NET Core CLI生成swagger合同:
https://github.com/domaindrivendev/Swashbuckle.AspNetCore#swashbuckleaspnetcorecli
但这仅适用于.NET Core API。对于.NET Framework,可以使用以下方法:
public static string GenerateSwagger(this IWebHost webhost, string docName, string basePath)
{
var sw = webhost.Services.GetRequiredService<ISwaggerProvider>();
var doc = sw.GetSwagger(docName, null, basePath);
using (var streamWriter = new StringWriter())
{
var writer = new OpenApiJsonWriter(streamWriter);
doc.SerializeAsV3(writer);
return streamWriter.ToString();
}
}
如果您想使用YAML摇号合约,可以将OpenApiJsonWriter
改成OpenApiYamlWriter
。
如果要使用V2大摇大摆合同,可以将SerializeAsV3
切换为SerializeAsV2
。