使用 Swashbuckle V5 从代码生成 swagger.json

Question

我正在使用 Swashbuckle AspNetCore v4.xx 并升级到 v5.1.xx 但我使用的代码不再工作，因为缺少类“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);

我该如何做才能像 v4 一样工作，但使用新版本的 Swashbuckle AspnetCore ？

Answer 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 swagger 合约，你可以使用OpenApiJsonWriter它。OpenApiYamlWriter

如果您想要 V2 swagger 合同，您可以切换SerializeAsV3到。SerializeAsV2