Як передавати кілька параметрів методу get в ASP.NET Core


107

Як я можу передати декілька параметрів для отримання методів у контролері MVC 6. Наприклад, я хочу мати щось подібне.

[Route("api/[controller]")]
public class PersonController : Controller
{
    public string Get(int id)
    {
    }

    public string Get(string firstName, string lastName)
    {

    }

    public string Get(string firstName, string lastName, string address)
    {

    }
}

Тож я можу запитувати як.

api/person?id=1
api/person?firstName=john&lastName=doe
api/person?firstName=john&lastName=doe&address=streetA

Відповіді:


91

Ви також можете скористатися цим:

// GET api/user/firstname/lastname/address
[HttpGet("{firstName}/{lastName}/{address}")]
public string GetQuery(string id, string firstName, string lastName, string address)
{
    return $"{firstName}:{lastName}:{address}";
}

Примітка : Будь ласка , зверніться до Metalheart - х і metalheartі Mark Hughesдля можливо кращого підходу.


21
Поки вам не доведеться обзавестись усіма однаковими прізвищами :)
Філіп Коплі

14
Це дійсно поганий спосіб проектувати маршрути API ... Зовсім не RESTful.
Томас Левеск

7
Наведений вище підхід виглядає дуже громіздким, не розумійте, чому в ньому так багато відгуків.
Bernoulli IT

1
@ThomasLevesque Що ти мав на увазі під цим, не будучи РЕСТАВНИМ?
Бруно Сантос

2
@BrunoSantos не дотримується принципів REST. URI повинні однозначно ідентифікувати ресурси. Тут не так (тут може бути декілька осіб з однаковим іменем та прізвищем, і адресу точно не можна вважати ідентифікатором)
Thomas Levesque

60

Чому б не використовувати лише одну дію контролера?

public string Get(int? id, string firstName, string lastName, string address)
{
   if (id.HasValue)
      GetById(id);
   else if (string.IsNullOrEmpty(address))
      GetByName(firstName, lastName);
   else
      GetByNameAddress(firstName, lastName, address);
}

Інший варіант - використовувати маршрутизацію атрибутів, але тоді вам потрібно буде мати інший формат URL:

//api/person/byId?id=1
[HttpGet("byId")] 
public string Get(int id)
{
}

//api/person/byName?firstName=a&lastName=b
[HttpGet("byName")]
public string Get(string firstName, string lastName, string address)
{
}

Так, я вирішую це зараз, використовуючи лише одну дію з усіма атрибутами, за якими я хочу мати змогу шукати особу. Як і загальний пошук. Я хотів би хоч, якби там, де є спосіб перевантажити дії в контролері, але це може бути не так.
mstrand

3
це не працює з .net core 2.0, оскільки насправді не створюється дійсний шаблон URL-адреси.
ЗЗЗ

44

Щоб розібрати параметри пошуку з URL-адреси, потрібно анотувати параметри методу контролера за допомогою [FromQuery], наприклад:

[Route("api/person")]
public class PersonController : Controller
{
    [HttpGet]
    public string GetById([FromQuery]int id)
    {

    }

    [HttpGet]
    public string GetByName([FromQuery]string firstName, [FromQuery]string lastName)
    {

    }

    [HttpGet]
    public string GetByNameAndAddress([FromQuery]string firstName, [FromQuery]string lastName, [FromQuery]string address)
    {

    }
}

6
навіщо вам це потрібно? Прив'язка параметрів із рядка запиту відбувається за замовчуванням ...
metalheart

Я спробував і те й інше, але перевантажуючи, як намагаюся робити помилки з або без [FromQuery]
mstrand

2
@mstrand Я оновив - дайте ходити, подивіться додаткові [HttpGet]примітки, різні назви методів та конкретний маршрут в [Route]- маршрути тепер мають бути повністю явними, що усуває декілька можливих проблем.
Марк Хьюз

9

Я думаю, що найпростіший спосіб - просто використовувати AttributeRouting.

[Route("api/YOURCONTROLLER/{paramOne}/{paramTwo}")]
    public string Get(int paramOne, int paramTwo)
    {
        return "The [Route] with multiple params worked";
    }

Чи можу я використовувати бажаний тип посилання? Тобто,int paramOne, string paramTwo
k4s

Використовуйте [Route ("api / YOURCONTROLLER / {paramOne} / {paramTwo?}")], Якщо ви хочете, щоб ваш другий параметр був необов’язковим
Anytoe

8

Я б запропонував використовувати окремий об'єкт dto як аргумент:

[Route("api/[controller]")]
public class PersonController : Controller
{
    public string Get([FromQuery] GetPersonQueryObject request)
    {
        // Your code goes here
    }
}

public class GetPersonQueryObject 
{
    public int? Id { get; set; }
    public string Firstname { get; set; }
    public string Lastname { get; set; }
    public string Address { get; set; }
}

Dotnet буде відображати поля для вашого об'єкта.

Це полегшить проходження ваших параметрів і призведе до набагато чіткішого коду.


5

Для виклику отримати з декількома параметрами в ядрі веб-api

  [ApiController]
    [Route("[controller]")]
    public class testController : Controller
    {

      [HttpGet]
        [Route("testaction/{id:int}/{startdate}/{enddate}")]
        public IEnumerable<classname> test_action(int id, string startdate, string enddate)
        {

            return List_classobject;
        }

    }

In web browser
https://localhost:44338/test/testaction/3/2010-09-30/2012-05-01

3

Щоб додати ще детальну інформацію про перевантаження, про яку ви запитали у своєму коментарі після іншої відповіді, ось короткий виклад. Коментарі в ApiControllerшоу, дія яких буде викликано під час кожного GETзапиту:

public class ValuesController : ApiController
{
    // EXPLANATION: See the view for the buttons which call these WebApi actions. For WebApi controllers, 
    //          there can only be one action for a given HTTP verb (GET, POST, etc) which has the same method signature, (even if the param names differ) so
    //          you can't have Get(string height) and Get(string width), but you can have Get(int height) and Get(string width).
    //          It isn't a particularly good idea to do that, but it is true. The key names in the query string must match the
    //          parameter names in the action, and the match is NOT case sensitive. This demo app allows you to test each of these
    //          rules, as follows:
    // 
    // When you send an HTTP GET request with no parameters (/api/values) then the Get() action will be called.
    // When you send an HTTP GET request with a height parameter (/api/values?height=5) then the Get(int height) action will be called.
    // When you send an HTTP GET request with a width parameter (/api/values?width=8) then the Get(string width) action will be called.
    // When you send an HTTP GET request with height and width parameters (/api/values?height=3&width=7) then the 
    //          Get(string height, string width) action will be called.
    // When you send an HTTP GET request with a depth parameter (/api/values?depth=2) then the Get() action will be called
    //          and the depth parameter will be obtained from Request.GetQueryNameValuePairs().
    // When you send an HTTP GET request with height and depth parameters (/api/values?height=4&depth=5) then the Get(int height) 
    //          action will be called, and the depth parameter would need to be obtained from Request.GetQueryNameValuePairs().
    // When you send an HTTP GET request with width and depth parameters (/api/values?width=3&depth=5) then the Get(string width) 
    //          action will be called, and the depth parameter would need to be obtained from Request.GetQueryNameValuePairs().
    // When you send an HTTP GET request with height, width and depth parameters (/api/values?height=7&width=2&depth=9) then the 
    //          Get(string height, string width) action will be called, and the depth parameter would need to be obtained from 
    //          Request.GetQueryNameValuePairs().
    // When you send an HTTP GET request with a width parameter, but with the first letter of the parameter capitalized (/api/values?Width=8) 
    //          then the Get(string width) action will be called because the case does NOT matter.
    // NOTE: If you were to uncomment the Get(string height) action below, then you would get an error about there already being  
    //          a member named Get with the same parameter types. The same goes for Get(int id).
    //
    // ANOTHER NOTE: Using the nullable operator (e.g. string? paramName) you can make optional parameters. It would work better to
    //          demonstrate this in another ApiController, since using nullable params and having a lot of signatures is a recipe
    //          for confusion.

    // GET api/values
    public IEnumerable<string> Get()
    {
        return Request.GetQueryNameValuePairs().Select(pair => "Get() => " + pair.Key + ": " + pair.Value);
        //return new string[] { "value1", "value2" };
    }

    //// GET api/values/5
    //public IEnumerable<string> Get(int id)
    //{
    //    return new string[] { "Get(height) => height: " + id };
    //}

    // GET api/values?height=5
    public IEnumerable<string> Get(int height) // int id)
    {
        return new string[] { "Get(height) => height: " + height };
    }

    // GET api/values?height=3
    public IEnumerable<string> Get(string height)
    {
        return new string[] { "Get(height) => height: " + height };
    }

    //// GET api/values?width=3
    //public IEnumerable<string> Get(string width)
    //{
    //    return new string[] { "Get(width) => width: " + width };
    //}

    // GET api/values?height=4&width=3
    public IEnumerable<string> Get(string height, string width)
    {
        return new string[] { "Get(height, width) => height: " + height + ", width: " + width };
    }
}

Для цього вам знадобиться лише один маршрут, якщо ви задумалися:

    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

і ви можете протестувати все це за допомогою MVC-перегляду чи чогось простого. Так, я знаю, що ви не повинні змішувати JavaScript з розміткою, і я не використовую завантажувальний інструмент, як зазвичай, але це лише для демонстраційних цілей.

<div class="jumbotron">
    <h1>Multiple parameters test</h1>
    <p class="lead">Click a link below, which will send an HTTP GET request with parameters to a WebAPI controller.</p>
</div>
<script language="javascript">
    function passNothing() {
        $.get("/api/values", function (data) { alert(data); });
    }

    function passHeight(height) {
        $.get("/api/values?height=" + height, function (data) { alert(data); });
    }

    function passWidth(width) {
        $.get("/api/values?width=" + width, function (data) { alert(data); });
    }

    function passHeightAndWidth(height, width) {
        $.get("/api/values?height=" + height + "&width=" + width, function (data) { alert(data); });
    }

    function passDepth(depth) {
        $.get("/api/values?depth=" + depth, function (data) { alert(data); });
    }

    function passHeightAndDepth(height, depth) {
        $.get("/api/values?height=" + height + "&depth=" + depth, function (data) { alert(data); });
    }

    function passWidthAndDepth(width, depth) {
        $.get("/api/values?width=" + width + "&depth=" + depth, function (data) { alert(data); });
    }

    function passHeightWidthAndDepth(height, width, depth) {
        $.get("/api/values?height=" + height + "&width=" + width + "&depth=" + depth, function (data) { alert(data); });
    }

    function passWidthWithPascalCase(width) {
        $.get("/api/values?Width=" + width, function (data) { alert(data); });
    }
</script>
<div class="row">
    <button class="btn" onclick="passNothing();">Pass Nothing</button>
    <button class="btn" onclick="passHeight(5);">Pass Height of 5</button>
    <button class="btn" onclick="passWidth(8);">Pass Width of 8</button>
    <button class="btn" onclick="passHeightAndWidth(3, 7);">Pass Height of 3 and Width of 7</button>
    <button class="btn" onclick="passDepth(2);">Pass Depth of 2</button>
    <button class="btn" onclick="passHeightAndDepth(4, 5);">Pass Height of 4 and Depth of 5</button>
    <button class="btn" onclick="passWidthAndDepth(3, 5);">Pass Width of 3 and Depth of 5</button>
    <button class="btn" onclick="passHeightWidthAndDepth(7, 2, 9);">Pass Height of 7, Width of 2 and Depth of 9</button>
    <button class="btn" onclick="passHeightWidthAndDepth(7, 2, 9);">Pass Height of 7, Width of 2 and Depth of 9</button>
    <button class="btn" onclick="passWidthWithPascalCase(8);">Pass Width of 8, but with Pascal case</button>
</div>

1

введіть тут опис зображення

Примітка. Я видалив FromURI. Якщо я можу передати значення з URL-адреси та отримати результат. Якщо хто-небудь знатиме бензиффліфти за допомогою фріру, дайте мені знати


Як зазначено в документації для прив'язки параметрів [1] простих типів, "(int, bool, double та ін.), Плюс TimeSpan, DateTime, Guid, десяткові та рядкові" автоматично будуть зчитуватися з URI. Атрибут [FromURI] необхідний, коли параметр не одного з цих типів примушує тіло зчитувати ті з URI, а не їх місце за замовчуванням. Для повноти атрибут [FromBody] робить по суті навпаки складні типи. [1] docs.microsoft.com/en-us/aspnet/web-api/overview/… )
Seb Andraos

1

Ви можете просто зробити наступне:

    [HttpGet]
    public async Task<IActionResult> GetAsync()
    {
        string queryString = Request.QueryString.ToString().ToLower();

        return Ok(await DoMagic.GetAuthorizationTokenAsync(new Uri($"https://someurl.com/token-endpoint{queryString}")));
    }

Якщо вам потрібно отримати доступ до кожного елемента окремо, просто зверніться до нього Request.Query.


1

Методи повинні бути такими:

[Route("api/[controller]")]
public class PersonsController : Controller
{
    [HttpGet("{id}")]
    public Person Get(int id)

    [HttpGet]
    public Person[] Get([FromQuery] string firstName, [FromQuery] string lastName, [FromQuery] string address)
}

Зверніть увагу, що другий метод повертає масив об'єктів, а ім'я контролера знаходиться в множині (Persons not Person).

Тож якщо ви хочете отримати ресурс за id, це буде:

api/persons/1

якщо ви хочете взяти об’єкти за деякими критеріями пошуку, такими як ім'я та ін., ви можете виконати пошук таким чином:

api/persons?firstName=Name&...

І рухаючись вперед, якщо ви хочете прийняти замовлення цієї особи (наприклад), це має бути таким:

api/persons/1/orders?skip=0&take=20

І метод у тому ж контролері:

    [HttpGet("{personId}/orders")]
    public Orders[] Get(int personId, int skip, int take, etc..)

0
    public HttpResponseMessage Get(int id,string numb)
    {

        using (MarketEntities entities = new MarketEntities())
        {
          var ent=  entities.Api_For_Test.FirstOrDefault(e => e.ID == id && e.IDNO.ToString()== numb);
            if (ent != null)
            {
                return Request.CreateResponse(HttpStatusCode.OK, ent);
            }
            else
            {
                return Request.CreateErrorResponse(HttpStatusCode.NotFound, "Applicant with ID " + id.ToString() + " not found in the system");
            }
        }
    }

0

Найпростіший спосіб,

Контролер:

[HttpGet("empId={empId}&startDate={startDate}&endDate={endDate}")]
 public IEnumerable<Validate> Get(int empId, string startDate, string endDate){}

Запит пошти:

{router}/empId=1&startDate=2020-20-20&endDate=2020-20-20

Точка навчання: Запит точної схеми приймається Контролером.

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.