Jak przekazać wiele parametrów do metody Get w ASP.NET Core


108

Jak mogę przekazać wiele parametrów, aby uzyskać metody w kontrolerze MVC 6. Na przykład chcę mieć coś takiego, jak to.

[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)
    {

    }
}

Więc mogę zapytać jak.

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

Odpowiedzi:


92

Możesz również użyć tego:

// 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}";
}

Uwaga : Proszę odnieść się do metalheart's metalhearti, Mark Hughesaby uzyskać możliwie lepsze podejście.


22
Aż trzeba, żeby wszyscy mieli to samo nazwisko :)
Phillip Copley,

15
To naprawdę zły sposób projektowania tras API ... Wcale nie REST.
Thomas Levesque

7
Powyższe podejście wygląda na bardzo uciążliwe, nie rozumiem, dlaczego ma tak wiele głosów za.
Bernoulli IT

1
@ThomasLevesque Co miałeś na myśli mówiąc, że nie jest RESTful?
Bruno Santos

2
@BrunoSantos nie przestrzega zasad REST. Identyfikatory URI mają jednoznacznie identyfikować zasoby. Tak nie jest w tym przypadku (może być wiele osób o tym samym imieniu i nazwisku, a adresu z pewnością nie można uznać za identyfikator)
Thomas Levesque

61

Dlaczego nie użyć tylko jednej akcji kontrolera?

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

Inną opcją jest użycie routingu atrybutów, ale wtedy potrzebny byłby inny format adresu 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)
{
}

Tak, rozwiązuję go teraz, używając tylko jednej akcji obejmującej wszystkie atrybuty, na podstawie których chcę znaleźć osobę. Jak ogólne wyszukiwanie. Wolałbym jednak, gdyby istniał sposób na przeciążenie akcji w kontrolerze, ale może tak nie być.
mstrand

3
nie działa to z .net core 2.0, ponieważ w rzeczywistości nie jest generowany prawidłowy szablon adresu URL.
ZZZ

44

Aby przeanalizować parametry wyszukiwania z adresu URL, musisz dodać adnotację do parametrów metody kontrolera [FromQuery], na przykład:

[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
dlaczego miałbyś tego potrzebować? wiązanie parametrów z ciągu zapytania odbywa się domyślnie ...
metalheart

1
Próbowałem obu, ale przeciążam się, ponieważ próbuję nie udać się z lub bez [FromQuery]
mstrand

2
@mstrand Zaktualizowałem - spróbuj, zobacz dodatkowe [HttpGet]adnotacje, różne nazwy metod i konkretną trasę w [Route]- trasy powinny być teraz w pełni jawne, co eliminuje kilka możliwych problemów.
Mark Hughes,

9

Myślę, że najłatwiej jest po prostu użyć AttributeRouting.

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

Czy mogę użyć preferowanego typu odniesienia? To znaczyint paramOne, string paramTwo
k4s

Użyj [Route ("api / YOURCONTROLLER / {paramOne} / {paramTwo?}")], Jeśli chcesz, aby drugi parametr był opcjonalny
Anytoe

8

Sugerowałbym użycie oddzielnego obiektu dto jako argumentu:

[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 zamapuje pola na Twój obiekt.

Ułatwi to przejście przez parametry i da w wyniku znacznie jaśniejszy kod.


5

Aby wywołać get z wieloma parametrami w rdzeniu interfejsu API sieci Web

  [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

Aby dodać więcej szczegółów na temat przeciążenia, o które pytałeś w swoim komentarzu po innej odpowiedzi, oto podsumowanie. Komentarze na ekranie ApiControllerpokazują, która akcja zostanie wywołana przy każdym GETzapytaniu:

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

Potrzebowałbyś do tego tylko jednej trasy, na wypadek gdybyś się zastanawiał:

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

i możesz to wszystko przetestować z tym widokiem MVC lub czymś podobnym. Tak, wiem, że nie powinno się mieszać JavaScript ze znacznikami i nie używam bootstrapu tak, jak zwykle, ale to jest tylko do celów demonstracyjnych.

<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

wprowadź opis obrazu tutaj

NB-Usunąłem FromURI. Mimo to mogę przekazać wartość z adresu URL i uzyskać wynik.Jeśli ktoś zna zalety korzystania z fromuri, daj mi znać


Zgodnie z dokumentacją dotyczącą wiązania parametrów [1] typy proste „(int, bool, double itd.) Oraz TimeSpan, DateTime, Guid, decimal i string” zostaną automatycznie odczytane z identyfikatora URI. Atrybut [FromURI] jest wymagany, gdy parametr nie należy do żadnego z tych typów, aby wymusić odczyt tych z identyfikatora URI zamiast ich domyślnej lokalizacji, czyli treści. Ze względu na kompletność atrybut [FromBody] działa zasadniczo odwrotnie w przypadku typów złożonych. [1] docs.microsoft.com/en-us/aspnet/web-api/overview/… )
Seb Andraos,

1

Możesz po prostu wykonać następujące czynności:

    [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}")));
    }

Jeśli chcesz uzyskać dostęp do każdego elementu osobno, po prostu zapoznaj się z Request.Query.


1

Metody powinny wyglądać następująco:

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

Zwróć uwagę, że druga metoda zwraca tablicę obiektów, a nazwa kontrolera jest w liczbie mnogiej (Persons not Person).

Więc jeśli chcesz uzyskać zasób przez id, będzie to:

api/persons/1

jeśli chcesz wziąć obiekty według jakichś kryteriów wyszukiwania, takich jak imię itp., możesz przeprowadzić takie wyszukiwanie:

api/persons?firstName=Name&...

I idąc naprzód, jeśli chcesz przyjąć zamówienia tej osoby (na przykład), powinno wyglądać tak:

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

I metoda w tym samym kontrolerze:

    [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

Najprostszy sposób,

Kontroler:

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

Prośba listonosza:

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

Punkt nauki: Żądanie dokładnego wzoru zostanie zaakceptowane przez kontrolera.

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.