小编点评

**问题描述：** 当我们新增了一个控制器方法时，在运行 Swagger 时会直接报错，异常如下： ``` SwaggerGeneratorException: Conflicting method/path combination \"POST api/UserOperationExample\" for actions - WebApi.Controllers.UserOperationExampleController.GetUserInfoByPageList (WebApi),WebApi.Controllers.UserOperationExampleController.AddUserInfo (WebApi). Actions require a unique method/path combination for Swagger/OpenAPI 3.0. Use ConflictingActionsResolver as a workaround ``` **分析：** 异常描述表明，Swagger 需要一个唯一的方法/路径组合才能处理请求。由于我们添加了新的控制器方法，导致了路径冲突，从而导致问题出现。 **解决方案：** 解决方法是使用 `ConflictingActionsResolver` 来指定方法的路径。 `ConflictingActionsResolver` 可以帮助 Swagger 识别并选择唯一的路径。 **步骤：** 1. 在控制器类的 `Route` 属性中添加 `[HttpGet]` 或 `[HttpPost]` 标记。 2. 使用 `[Route]` 属性指定方法的路径。例如，如果我们的方法名是 `GetUserInfoByPageList`，我们可以使用 `[Route("api/UserOperationExample/GetUserInfoByPageList")]` 进行指定。 3. 如果有多个方法具有相同的路径，我们可以使用 `[HttpGet]` 或 `[HttpPost]` 属性的顺序来排序。 4. 创建一个 `ConflictingActionsResolver` 实例，并将其设置为 `controllers.resolver` 属性的值。 5. 在 `SwaggerGen` 配置中设置 `consoles` 和 `routes` 属性的值。 **示例：** ```csharp //控制器方法 [Route("api/UserOperationExample/GetUserInfoByPageList")] public IActionResult GetUserInfoByPageList() { // 方法代码 } // 配置 ConflictingActionsResolver services.AddSingleton(); // SwaggerGen 配置 public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // 设置 Swagger 的路径 app.UseSwaggerGen(options => { options.SwaggerGen.Resolver.RegisterRoutes(app.Application); options.SwaggerGen.Resolver.AddActionMapping( "GetUserInfoByPageList", "api/UserOperationExample", "GetUserInfoByPageList" ); }); } ``` **注意：** * `ConflictingActionsResolver` 的用法取决于你的项目结构和需求。 * `SwaggerGen` 会自动识别并使用 `ConflictingActionsResolver` 来选择唯一的路径。 * 确保你的路由格式正确，并确保路径中的命名符合 OpenAPI 3.0 的规范。

正文

遇到的问题

因为新增了一个控制器方法，从而导致在运行Swagger的时候直接报错，异常如下：

SwaggerGeneratorException: Conflicting method/path combination "POST api/UserOperationExample" for actions - WebApi.Controllers.UserOperationExampleController.GetUserInfoByPageList (WebApi),WebApi.Controllers.UserOperationExampleController.AddUserInfo (WebApi). Actions require a unique method/path combination for Swagger/OpenAPI 3.0. Use ConflictingActionsResolver as a workaround

 

解决方案

从上面报错的字面描述来看，说的就是对于Swagger/OpenAPI 3.0，Actions需要一个唯一的方法/路径组合，所以我们只需要在每个控制器的Route特性中增加完整的路由即可，如下所示：

添加完成后重新运行成功