亚洲在线久爱草,狠狠天天香蕉网,天天搞日日干久草,伊人亚洲日本欧美

為了賬號安全,請及時綁定郵箱和手機立即綁定
已解決430363個問題,去搜搜看,總會有你想問的

RESTful API 端點命名

RESTful API 端點命名

C#
肥皂起泡泡 2022-11-22 16:22:01
我正在開發一個公開 RESTful API 的 asp.net core 2.2 后端。當前的實現工作正常(為清楚起見刪除了額外的代碼):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 問題嗎?意思是控制器會以其他方式工作嗎?- 用戶或團隊控制器是否應該公開獲取所有團隊用戶的方法?我們按團隊 ID 查詢并返回用戶。- 如果它保留在用戶控制器中,那么擁有唯一端點的“最佳”方式是什么?
查看完整描述

4 回答

?
森欄

TA貢獻1810條經驗 獲得超5個贊

我會把它放在Teams控制器中并使用類似路由的方式接收它/teams/1/users- 其中 1 是團隊 ID。這更像是“休息”:)。您需要使用注釋您的 Teams 控制器操作[Route("{teamId}/users")].

但是,如果您想將其保留在用戶控制器中,則使用注釋團隊操作[Route("some-action-name/{teamId}")]并使用users/some-action-name/{teamId}



查看完整回答
反對 回復 2022-11-22
?
尚方寶劍之說

TA貢獻1788條經驗 獲得超4個贊

你可以Attribute Routing試一試,這就是我的意思


[HttpGet("/{userId}")]

public async Task<IActionResult> GetByUserId(Guid userId)


[HttpGet("/{teamId}")]

public async Task<IActionResult> GetByTeamId(Guid teamId)

[HttpGet("/{teamId}")]route用參數定義一個新的teamId


查看完整回答
反對 回復 2022-11-22
?
慕田峪9158850

TA貢獻1794條經驗 獲得超7個贊

you need to provide action name in your url.which is unique path

像這樣 https://localhost:5001/Users/GetByTeamId?teamId=4AF29C4A-282A-4FB8-8691-9D44398A97F2



查看完整回答
反對 回復 2022-11-22
?
慕桂英546537

TA貢獻1848條經驗 獲得超10個贊

嘗試向您的路由屬性添加操作,不要忘記將操作名稱添加到您的網址


namespace Sppd.TeamTuner.Controllers

{

   [Authorize]

   [ApiController]

   [Route("[controller]/[Action]")]

 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));

    }

  }


查看完整回答
反對 回復 2022-11-22
  • 4 回答
  • 0 關注
  • 174 瀏覽

添加回答

舉報

0/150
提交
取消
微信客服

購課補貼
聯系客服咨詢優惠詳情

幫助反饋 APP下載

慕課網APP
您的移動學習伙伴

公眾號

掃描二維碼
關注慕課網微信公眾號