NSwag默认接受对application / json的响应

问题描述

我正在将NSwag与Asp.Net Core API结合使用。我想将默认的接受响应从application/octet-stream更改为application/json。

我尝试将Response属性添加到API操作以及OpenApiMimeType，但是没有用。它仍然设置为application/octet-stream。我该如何更改？

更新： 这是API的操作之一。

[HttpPost("login")]
public async Task<ActionResult> Login(LoginDto dto,string returnUrl = null)
{
    //... omitted codes for brevity
    
    return Ok();
}

解决方法

使用Produce属性（https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.producesattribute）应该可以帮助您实现这一目标。

[HttpPost("login")]
[Produces("application/json")]
public async Task<ActionResult> Login(LoginDto dto,string returnUrl = null)
{
    //... omitted codes for brevity
    
    return Ok();
}

在您的swagger.json中，它应该会产生如下内容：Swagger.json-1

另一个原因是因为您使用的是Task<ActionResult>，因此您的swagger.json由于这种原因没有产生内容类型。

[HttpPost("login")]
[Produces("application/json")]
public async Task<ActionResult<return something>> Login(LoginDto dto,string returnUrl = null)
{
    //... omitted codes for brevity
    
    return Ok(return something);
}