WebAPI und Attribut-Routing

Question

Ich kann nicht scheinen, eine Antwort auf diese Frage zu finden, also poste ich es hier. Dies kann eine grundlegende Routing-Frage sein und vielleicht fehlt mir gerade etwas Offensichtliches. Ich habe ein WebAPI2-Projekt, das GetAll() -Methode in dem Controller hat. Ich verwende Attribut-Routing einschließlich eines RoutePrefix. Wenn ich die Methode mit Postman teste, funktioniert es einwandfrei http://localhost/api/v1/Suppressions und es gibt eine Liste von JSON aus meiner Mongo DB-Sammlung zurück. Zufällig während des Tests habe ich zufällig einen Parameter getestet und der URL hinzugefügt, dass ich einen Fehler "Die Ressource kann nicht gefunden werden" erhalten würde http://localhost/api/v1/Suppressions?name=abc, aber stattdessen die GetAll() Methode aufgerufen.

Während des Routings werden Parameter ignoriert und nur die URI verwendet (außer natürlich, ich habe eine Methode, die die Parameter wie Get (String-Name) genannt)? Wenn das der Fall ist, gibt es eine Route-Einschränkung, die ich meiner GetAll() -Methode hinzufügen muss, um den Fehler "die Ressource nicht gefunden werden" zu werfen, wenn jemand versehentlich die Methode mit einem Parameter oder einer Liste von Parametern aufgerufen?

Answer 1

Abfrageparameter werden im Routing ignoriert, sofern sie nicht im Uri angegeben sind. Sie können entweder eine separate Route für "Suppressions? Name = {name}" hinzufügen oder sie in Ihrem bestehenden Anruf bearbeiten.

Informationen zu passenden Uri finden Sie unter: UriTemplate.Match

Answer 2

Es hängt davon ab.

Nehmen wir an, Sie haben eine Methode wie die, die Sie beschreiben. Beispiel:

[RoutePrefix("api")] 
public class api: ApiController { 
    [HttpGet] 
    [Route("Supressions")] 
    public HttpResponseMessage GetAll(HttpRequestMessage request){ 
     ///etc 
    } 
} 

Diese Methode wird unabhängig von den verwendeten Parametern aufgerufen.

Wenn Sie jedoch so etwas wie dieses

[RoutePrefix("api")] 
public class api: ApiController { 
    [HttpGet] 
    [Route("Supressions/{abc}")] 
    public HttpResponseMessage Get(HttpRequestMessage request, string abc){ 
     ///etc 
    } 
} 

tun Sie den Parameter benötigen. Wenn Sie es nicht haben, und Sie http://localhost/api/Suppressions nennen, wird es so etwas wie dies zurück:

{ 
"message": "No HTTP resource was found that matches the request URI 'http://localhost:64307/api/Suppressions'.", 
"messageDetail": "No type was found that matches the controller named ''." 
} 

Nun, wenn Sie mehrere Parameter haben, können Sie so etwas wie dies tun können, und wenn Sie benutzen sie nicht in Ihr Anruf, es wird auch

[RoutePrefix("api")] 
public class api: ApiController { 
    [HttpGet] 
    [Route("Supressions")] 
    public HttpResponseMessage Get(HttpRequestMessage request, string abc, int id, int somethingElse){ 
     ///etc 
    } 
} 

Hier wird der Anruf so etwas zu beklagen wäre:

http://localhost:64307/api/Suppressions?abc=asdas&id=13&somethingElse=45

Hoffnung thi s helfen Ihnen zu verstehen