我正在一个asp.net核心2.2后端公开RESTful API。
当前实现工作正常(为清晰起见,删除了其他代码):
namespace Sppd.TeamTuner.Controllers
{
[Authorize]
[ApiController]
[Route("[controller]")]
public class UsersController : ControllerBase
{
private readonly ITeamTunerUserService _userService;
private readonly ITokenProvider _tokenProvider;
private readonly IAuthorizationService _authorizationService;
private readonly IMapper _mapper;
public UsersController(ITeamTunerUserService userService, ITokenProvider tokenProvider, IAuthorizationService authorizationService, IMapper mapper)
{
_userService = userService;
_tokenProvider = tokenProvider;
_authorizationService = authorizationService;
_mapper = mapper;
}
[HttpGet]
public async Task<IActionResult> GetByUserId(Guid userId)
{
// TODO: secure this call
var user = _userService.GetByIdAsync(userId);
return Ok(_mapper.Map<UserDto>(await user));
}
}
}
单一API方法可与URL https:// localhost:5001 / Users?userId = 4AF29C4A-282A-4FB8-8691-9D44398A97F2配合使用
现在,我想添加第二种方法:
[HttpGet]
public async Task<IActionResult> GetByTeamId(Guid teamId)
{
// TODO: secure this call
var users = _userService.GetByTeamIdAsync(teamId);
return Ok(_mapper.Map<IEnumerable<UserDto>>(await users));
}
这将导致URL https:// localhost:5001 / Users?teamId = 4AF29C4A-282A-4FB8-8691-9D44398A97F2(请注意,与首次调用相比,该参数是teamId而不是userId)。
使用SwaggerUI进行测试时,该页面不会加载,并显示以下异常:
An unhandled exception has occurred while executing the request.
System.NotSupportedException: HTTP method "GET" & path "Users" overloaded by actions - Sppd.TeamTuner.Controllers.UsersController.GetByUserId (Sppd.TeamTuner),Sppd.TeamTuner.Controllers.UsersController.GetByTeamId (Sppd.TeamTuner). Actions require unique method/path combination for Swagger 2.0. Use ConflictingActionsResolver as a workaround
at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.CreatePathItem(IEnumerable`1 apiDescriptions, ISchemaRegistry schemaRegistry)
at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](IEnumerable`1 source, Func`2 keySelector, Func`2 elementSelector, IEqualityComparer`1 comparer)
at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.CreatePathItems(IEnumerable`1 apiDescriptions, ISchemaRegistry schemaRegistry)
at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetSwagger(String documentName, String host, String basePath, String[] schemes)
at Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext, ISwaggerProvider swaggerProvider)
at Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.Invoke(HttpContext httpContext)
at Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.Invoke(HttpContext httpContext)
at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)
问题:
-这是SwaggerUI问题吗?这意味着控制器可以正常工作吗?
-用户或团队控制器是否应该公开该方法以获取所有团队用户?我们通过团队ID查询并返回用户。
-如果保留在“用户”控制器中,拥有唯一端点的“最佳”方法是什么?
我会将其放在Teams
控制器中,并使用类似/teams/1/users
-1的团队ID之类的路由来接收它。这是更多的“休息” :)。您将需要使用以下方式注释您的Teams控制器操作[Route("{teamId}/users")].
但是,如果要将其保留在“用户”控制器中,请使用注释团队操作[Route("some-action-name/{teamId}")]
并使用进行访问users/some-action-name/{teamId}
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句