渲染CSV示例swashbuckle

发布于 2025-01-24 16:47:55 字数 1149 浏览 2 评论 0原文

我有一个可以返回CSV或JSON的API，对接受标题MimeType。

我已经用[careed（“ application/json”，“ text/csv”）进行了装饰该方法]。这是一个带有ASP.NET核心默认项目的MRE：

public class WeatherForecast
{
    public DateTime Date { get; set; }
    public int TemperatureC { get; set; }
    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
    public string? Summary { get; set; }
}

[HttpGet(Name = "GetWeatherForecast")]
[Produces("application/json","text/csv")]
public IEnumerable<WeatherForecast> Get()
{
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = "Freezing"
    })
    .ToArray();
}

这可以在Swagger UI中进行MimeType选择，并且可以正确地添加到请求的Accept标题中。我的问题是，示例响应值不是以CSV的格式，而是作为JSON。

我如何配置如何为自定义模拟型（例如文本/CSV）渲染示例？

我正在使用swashbuckle.aspnetcore版本6.3.1。

原文

I have an API that can return an csv or json, deppending on the Accept header mimetype.

I've decorated the method with [Produces("application/json","text/csv")]. Here it is a MRE with the ASP.NET Core default project:

public class WeatherForecast
{
    public DateTime Date { get; set; }
    public int TemperatureC { get; set; }
    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
    public string? Summary { get; set; }
}

[HttpGet(Name = "GetWeatherForecast")]
[Produces("application/json","text/csv")]
public IEnumerable<WeatherForecast> Get()
{
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = "Freezing"
    })
    .ToArray();
}

This enables the mimetype selection in the Swagger UI, and it's being correct added to the Accept header of the request. My issue is that the example response value is not being formatted as csv, but as json.