如何在 XML 而不是 JSON 中显示 SwaggerResponse

Question

我想在 Swagger UI 中以 XML 格式而不是 JSON 格式显示响应。我怎样才能做到这一点？这是我要改编的代码：

[SwaggerResponse((int)HttpStatusCode.OK, Type = typeof(FeedModel))]  
public async Task<IActionResult> GetCompanyPostFeed(Guid companyId)
{
    var feed = new FeedModel();

    // Some database requests

    return Content(feed, "text/xml", Encoding.UTF8);
}

Answer 1

您可以尝试使用属性SwaggerProducesAttribute 来装饰方法，如here 所述：

[SwaggerProduces("text/xml")]
[SwaggerResponse((int)HttpStatusCode.OK, Type = typeof(FeedModel))]  
public async Task<IActionResult> GetCompanyPostFeed(Guid companyId)

为了保持对仅链接答案的厌恶，我将在此处复制该文章的一些相关内容：

[AttributeUsage(AttributeTargets.Method)]
public class SwaggerProducesAttribute : Attribute
{
    public SwaggerProducesAttribute(params string[] contentTypes)
    {
        this.ContentTypes = contentTypes;
    }

    public IEnumerable<string> ContentTypes { get; }
}

public class ProducesOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        var attribute = apiDescription.GetControllerAndActionAttributes<SwaggerProducesAttribute>().SingleOrDefault();
        if (attribute == null)
        {
            return;
        }

        operation.produces.Clear();
        operation.produces = attribute.ContentTypes.ToList();
    }
}

然后在 SwaggerConfig.cs 中，您将需要以下内容：

config
    .EnableSwagger(c =>
        {
            ...
            c.OperationFilter<ProducesOperationFilter>();
            ...
        }