Как передать несколько параметров методу get в ASP.NET Core


108

Как передать несколько параметров в методы Get в контроллере 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

Ответы:


94

Вы также можете использовать это:

// 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возможно, лучше.


22
Пока вам не нужно получить всех с одинаковой фамилией :)
Филипп Копли

15
Это действительно плохой способ разработки маршрутов API ... Совсем не RESTful.
Thomas Levesque

7
Вышеупомянутый подход выглядит очень громоздким, не понимаю, почему у него так много голосов.
Bernoulli IT

1
@ThomasLevesque Что вы имели в виду, говоря, что это не RESTful?
Бруно Сантос

2
@BrunoSantos не следует принципам REST. URI должны однозначно идентифицировать ресурсы. Здесь дело обстоит не так (может быть несколько человек с одинаковыми именем и фамилией, и адрес, конечно, не может считаться идентификатором)
Томас Левеск

61

Почему бы не использовать только одно действие контроллера?

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.
ZZZ

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

1
Я пробовал и то, и другое, но перегрузка, когда я пытаюсь сделать, терпит неудачу с [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

9

Я бы предложил использовать в качестве аргумента отдельный объект 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

Чтобы вызвать get с несколькими параметрами в ядре веб-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

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

NB-Я удалил FromURI. Тем не менее, я могу передать значение из URL-адреса и получить результат. Если кто-то знает преимущества использования fromuri, дайте мне знать


Как указано в документации для привязки параметров [1] простых типов, "(int, bool, double и т. Д.) Плюс TimeSpan, DateTime, Guid, decimal и string" будут автоматически считываться из URI. Атрибут [FromURI] требуется, когда параметр не входит в один из этих типов, чтобы принудительно читать те из URI, а не их местоположение по умолчанию, тело. Для полноты картины атрибут [FromBody] по существу действует наоборот со сложными типами. [1] docs.microsoft.com/en-us/aspnet/web-api/overview/… )
Себ

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

Обратите внимание, что второй метод возвращает массив объектов, а имя контроллера указано в plurar (Persons not Person).

Итак, если вы хотите получить ресурс по идентификатору, это будет:

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.