如何将不同类型的参数传递给 .Net 5 web Api

问题描述

我正在创建一个 .NET 5 Web API，我的控制器有两种方法，第一种是这样的 Get 方法：

[Route("GetRankingByListIdAll/{ListId}")]
[HttpGet]
public async Task<ActionResult> GetRankingByListIdAll([FromQuery] string ListId)
{
    var result = await _userService.GetRankingByListIdAll(ListId);
    return Ok(result);
}

另一种方法是像这样的 POST 方法：

[HttpPost("AddUser")]
public async Task<ActionResult> AddUser([FromBody] Model model)
{
    bool userInList = await _useRSService.validateEmailInUsers(model.email,model.otherProperty);
    if (!userInList)
    {
        var result = await _userService.addUser(model.property,model.otherProperty,model.proper);
        return Ok(result);
    }
    else
    {
        return BadRequest("message");
    }
}

正如你在get方法中看到的我把“[Route]”设置路由，在post方法中我把路由放在[HttpPost("")]中，但是我不能传递参数，我有在 Get 方法中尝试使用这样的路线： [HttpGet("GetRankingByListIdAll/{ListId}")] 但它也不起作用 在 Get 方法中，我正在使用此请求： https://localhost:44340/api/User/GetUserByListId/ListId=59D512FB-1CCF-47E2-8E85-B4F76192D941 我的控制器称为“UserController”，我的 api 使用 JWT 进行了身份验证 在 .net core 2.2 中，这个 API 工作正常，但我还没有找到如何在 .net 5 中做到这一点，我想知道是否有人可以帮助我。

解决方法

.Net 5 中关于具有属性路由 i 的 REST API 几乎没有变化。我强烈建议您阅读以下内容：

Attribute Routing in ASP.NET Web API 2

Create a REST API with Attribute Routing in ASP.NET Web API 2。

没有提及更改：

Breaking changes in .NET 5

对于如下配置的路由

[HttpGet("GetRankingByListIdAll/{ListId}")]

您的 http 请求应显示为

/GetUserByListId/59D512FB-1CCF-47E2-8E85-B4F76192D941

您不应在 url 中指定参数名称。由于参数不是来自querystring，因此您也不应该指定[FromQuery]。

[Route("GetRankingByListIdAll/{ListId}")]
[HttpGet]
public async Task<ActionResult> GetRankingByListIdAll(string ListId)
{
  //....
}

为了澄清网址：

https:∕∕www.mydomain.com∕a∕b∕c∕1∕2∕3?z=1&b=2#tag

细分为：

Scheme: https          //before the colon (:)
host: www              //before the first period (.)
domain: mydomain.com   //before the first slash (/)
path: /a/b/c/1/2/3     //before the question mark (?)
querystring: z=1&b=2   //before the hash/pound symbol (#)
fragment: tag          //after the hash/pound symbol

（一般来说）

,

正如你在 get 方法中看到的，我用“[Route]”来设置路由和 在 post 方法中，我将路由放在 [HttpPost("")] 中，但我不能 传递参数，我在Get方法中尝试过使用路由 像这样： [HttpGet("GetRankingByListIdAll/{ListId}")] 但它没有 在我使用此请求的 Get 方法中工作： https://localhost:44340/api/User/GetUserByListId/ListId=59D512FB-1CCF-47E2-8E85-B4F76192D941 我的控制器被称为“UserController”，我的 api 有授权 在 .net core 2.2 中使用 JWT 这个 API 工作正常，但我还没有找到 如何在 .net 5 中做到这一点，我想知道是否有人可以帮助我。

[HttpGet("GetRankingByListIdAll/{ListId}")]

[Route("GetRankingByListIdAll/{ListId}")]

当你像上面一样使用Route属性和HttpGet方法时，由于参数是从路由传递过来的，所以如果你在Get方法中使用了[FormBody]属性，你无法获得价值。

为了解决这个问题，使用[FromRoute]属性，代码如下：

    [HttpGet]
    [Route("GetRankingByListIdAll/{ListId}")]
    public async Task<ActionResult> GetRankingByListIdAll([FromRoute] string ListId)
    {
        var result = "Entered Id: " + ListId;
        return Ok(result);
    }

然后用PostMan检查，结果如下：

而如果你使用JQuery来调用API方法，代码如下：

<input type="button" value="Call Get Method" id="btnGet" />
<input type="button" value="Call Post Method" id="btnPost" />

<div id="result"></div>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<script>
    $(function () {
        $("#btnGet").click(function () {
            var listid = "Num1002";
            $.ajax({
                url: "/api/ToDo/GetRankingByListIdAll/" + listid,//The url like this: https://localhost:44355/api/ToDo/GetRankingByListIdAll/NV1003
                method: "Get",success: function (res) {
                    $("#result").html(res);
                },error: function (error) {
                    alert("error");
                }
            });
        });
        $("#btnPost").click(function () {
            var user = {};
            user.UserId = 1002;
            user.UserName = "Tom";

            $.ajax({
                url: "/api/ToDo/AddUser",//the url like this:https://localhost:44355/api/ToDo/AddUser
                method: "Post",contentType: "application/json; charset=utf-8",traditional: true,//if the user object is a complex objects,try to add this attribute.
                data: JSON.stringify(user),error: function (error) {
                    alert(error);
                }
            });
        });
    });
</script>

结果如下：