NSwag无法为继承自控制器的类生成Swagger。

Question

在我的ASP.NET Core应用中，我正在使用NSwag来生成我的swagger.json文件。

当我构建项目时，遇到了如下错误：

Severity  Code    Description Project File    Line    Suppression State
Error MSB3073 The command "dotnet
".nuget\packages
swag.msbuild\13.20.0\buildTransitive../tools/Net70/dotnet-nswag.dll"
run aspnetcoretoopenapi.json
/variables:"input=\src\ApiGateway.Api\ApiGateway.Api.csproj,output=\src\ApiGateway.Api../swagger/ApiGateway.Api.json,configuration=Debug,documentName=Public
API"" exited with code
-1.
ApiGateway.Api  \src\Cat.Infrastructure\Build\CreateSwaggerDocument.targets

我的控制器代码如下：

[ApiController]
[Route("v1/[controller]")]
public class MyController : MyControllerBase
{
    [HttpGet("{id}/result")]
    public async Task<IActionResult> Get([FromRoute] int id)
    {
        return await ForwardRequest(HttpMethod.Get, 
            "http://localhost/v2/result");
    }
}

public class MyControllerBase : ControllerBase 
{
    public async Task<IActionResult> ForwardRequest(HttpMethod httpMethod, string url, object? body = null)
    {
        // do something.
    }
}

当我在MyController中直接放置“ForwardRequest”方法的逻辑，并移除继承关系时，一切都能正常运作。
但当我开始使用MyControllerBase类时，功能就失效了。

我忽略了什么呢？

David G · Answer

您需要在基类方法上也添加诸如 [HttpPost]、[HttpGet]、[HttpPut] 等HTTP动词特性，但请参考以下示例：

基类

public class MyControllerBase : ControllerBase
{
    public MyControllerBase()
    {
    }

    // 示例：假设您想让这个方法可用于GET请求
    [HttpGet]
    public virtual async Task ForwardRequest([FromQuery] HttpRequest request, string url, object? body = null)
    {
        // 在此处填写代码...
    }
}

实现类

[ApiController]
[Route("v1/[controller]")]
public class MyController : MyControllerBase
{
    [HttpGet("{id}/result")]
    public async Task Get([FromRoute] int id)
    {
        return await ForwardRequest(HttpMethod.Get, 
            "http://localhost/v2/result");
    }
}

Cody Gray - on strike · Answer

在API端点参数中，HttpMethod可以用字符串代替。

注意：我使用了[HttpPost]是因为“object? body”将会来自请求体（FromBody）。虽然也可以使用[HttpGet]，但在Swagger中您将无法使用带有请求体的方法。

using Microsoft.AspNetCore.Mvc;

namespace WebAppTestController.Controllers
{
  [ApiController]
  [Route("[controller]")]
  public class MyController : MyControllerBase
  {
    [HttpGet("{id}/result")]
    public async Task Get([FromRoute] int id)
    {
      // 将HttpMethod转换为字符串传递给基类方法
      return await ForwardRequest(HttpMethod.Get.ToString(), "http://localhost/v2/result");
    }
  }

  public class MyControllerBase : ControllerBase
  {
    // 使用[HttpPost]，尽管处理的是GET、POST等多种方法
    [HttpPost]
    public async Task ForwardRequest(string method, string url, object? body = null)
    {
      // 将接收到的字符串转换回HttpMethod实例
      var httpMethod = new HttpMethod(method);

      // 实际处理逻辑在此处省略，仅返回Ok状态码
      return Ok();
    }
  }
}