Abfragezeichenfolge funktioniert nicht, während Attributrouting verwendet wird

Ich bin mit System.Web.Http.RouteAttribute und System.Web.Http.RoutePrefixAttribute zu ermöglichen sauberere URLs für meine Web API 2 Anwendung. Für die meisten meiner Anfragen, die ich verwenden kann-routing (zB. Controller/param1/param2) oder ich kann verwenden Sie query-strings (zB. Controller?param1=bob&param2=mary).

Leider mit einem meiner Controller (und nur eine), diese schlägt fehl. Hier ist mein Controller:

[RoutePrefix("1/Names")]
public class NamesController : ApiController
{

    [HttpGet]
    [Route("{name}/{sport}/{drink}")]
    public List<int> Get(string name, string sport, string drink)
    {
        //Code removed...
    }

    [HttpGet]
    [Route("{name}/{drink}")]
    public List<int> Get(string name, string drink)
    {
        //Code removed...
    }
}

Wenn ich eine Anfrage entweder über routing, funktionieren beide gut. Allerdings, wenn ich einen query-string, versäumt es, mir zu sagen, dass dieser Pfad nicht existiert.

Habe ich versucht, indem Sie das folgende zu meinem WebApiConfig.cs Klasse' Register(HttpConfiguration config) - Funktion (vor und nach der Default-route), aber es half nichts:

config.Routes.MapHttpRoute(
name: "NameRoute",
routeTemplate: "{verId}/Names/{name}/{sport}/{drink}",
defaults: new { name = RouteParameter.Optional, sport = RouteParameter.Optional, drink = RouteParameter.Optional },
constraints: new { verId = @"\d+" });

Also für die Klarheit, ich möchte in der Lage sein, beides zu tun:

localhost:12345/1/Names/Ted/rugby/coke
localhost:12345/1/Names/Ted/coke

und

localhost:12345/1/Names?name=Ted&sport=rugby&drink=coke
localhost:12345/1/Names?name=Ted&drink=coke

aber leider ist der query-string-Versionen funktionieren nicht! 🙁

Aktualisiert

Habe ich entfernt, die zweite Aktion zusammen und versucht nun, die Verwendung von nur einer einzigartigen Aktion mit optionalen Parametern. Ich habe mich verändert meine route Attribut [Route("{name}/{drink}/{sport?}")] als Tony vorschlug, sport machen null-Werte zulässt, aber dies jetzt verhindert localhost:12345/1/Names/Ted/coke wird eine gültige route aus irgendeinem Grund. Query-strings sind gleich Verhalten wie zuvor.

Update 2
Ich habe jetzt eine einzigartige Aktion in meinem controller:

[RoutePrefix("1/Names")]
public class NamesController : ApiController
{

    [HttpGet]
    [Route("{name}/{drink}/{sport?}")]
    public List<int> Get(string name, string drink, string sport = "")
    {
        //Code removed...
    }
}

aber immer noch, mithilfe von query strings nicht finden einen geeigneten Weg, während der Verwendung der routing-Methode.

InformationsquelleAutor der Frage Chris Paton | 2014-03-25

  1. 49

    War ich vor dem gleichen Problem " Wie such-Parameter als query-string?', während ich versuchte, zu bauen eine web-api für mein Aktuelles Projekt. Nach googeln, die folgenden arbeiten gut für mich:

    Api-controller Aktion:

    [HttpGet, Route("search/{categoryid=categoryid}/{ordercode=ordercode}")]

public Task<IHttpActionResult> GetProducts(string categoryId, string orderCode)
{

}

    Die url habe ich versucht durch Postboten:

    http://localhost/PD/search?categoryid=all-products&ordercode=star-1932

http://localhost/PD is my hosted api

    InformationsquelleAutor der Antwort Mosharaf Hossain

  2. 34

    Nach viel mühsame tüfteln und Googeln, habe ich mit einem 'fix'. Ich weiß nicht, ob das ideal ist/best practice/plain old falsch, aber es löst mein Problem.

    Alles, was ich Tat, war fügen Sie [Route("")] neben der route Attribute ich war ja schon mit. Dies ist im Grunde mit der Web-API-2-routing zu ermöglichen, query-strings, wie ist das nun eine gültige Route.

    Ein Beispiel wäre jetzt:

    [HttpGet]
[Route("")]
[Route("{name}/{drink}/{sport?}")]
public List<int> Get(string name, string drink, string sport = "")
{
    //Code removed...
}

    Dies macht sowohl localhost:12345/1/Names/Ted/coke und localhost:12345/1/Names?name=Ted&drink=coke gültig.

    InformationsquelleAutor der Antwort Chris Paton

  3. 11

    Mit dem Attribut-routing müssen Sie angeben, default-Werte, so dass Sie wäre optional.

    [Route("{name}/{sport=Football}/{drink=Coke}")]

    Zuweisung eines Wertes erlauben es optional sein, so dass Sie nicht haben, um es aufzunehmen, und es wird übergeben Sie den Wert angeben.

    Habe ich nicht getestet, der Abfragezeichenfolge für dieses, aber es sollte die gleiche Arbeit.

    Ich nur wieder Lesen die Frage, und ich sehe, dass Sie 2 Bekommen Verben mit dem gleichen Pfad, ich glaube, das würde zu Konflikten führen, wie routing würde nicht wissen, welches man nutzen, vielleicht mit der optionalen params helfen. Sie können auch angeben, man kann null sein, und eine überprüfung in der Methode, wie es weiter gehen wird.

    [Route("{name}/{sport?}/{drink?}")]

    Dann überprüfen Sie die Variablen in der Methode zu sehen, ob Sie null sind und zu handhaben, wie gebraucht.

    Hoffe, das hilft, einige? lol

    Wenn nicht vielleicht diese Website, es hat mehr details über Attribut-routing.

    http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2

    Clip von dieser site:

    Optionale Parameter und default-Werte können Sie angeben, dass eine
    parameter optional ist, indem ein Fragezeichen, um die parameter, die
    ist:

    [Route("countries/{name?}")]
public Country GetCountry(string name = "USA") { }

    Derzeit, wird ein default-Wert muss angegeben werden, auf der optionale parameter
    für die Aktion Auswahl um erfolgreich zu sein, aber wir können untersuchen, heben,
    Einschränkung. (Bitte lassen Sie uns wissen, wenn es wichtig ist.)

    Können Standardwerte angegeben werden, die in ähnlicher Weise:

    [Route("countries/{name=USA}")]
public Country GetCountry(string name) { }

    Den optionalen parameter '?' und die Standard-Werte angezeigt werden muss, nach
    inline-constraints in der parameter-definition.

    InformationsquelleAutor der Antwort Tony

  4. 5

    Nur eine Randnotiz aus meinem Teil auch. Um für die queryString-Parametern zu arbeiten, müssen Sie einen default-Wert für die Methode Parameter, um es optional. So wie Sie auch tun würde, wenn Sie normalerweise den Aufruf einer C# - Methode.

    [RoutePrefix("api/v1/profile")]
public class ProfileController : ApiController
{

   ...

   [HttpGet]
   [Route("{profileUid}")]
   public IHttpActionResult GetProfile(string profileUid, long? someOtherId) 
   {
      //...
   }

   ...

}

    Dies ermöglicht es mir, rufen Sie den Endpunkt wie diese:

    /api/v1/profile/someUid
/api/v1/profile/someUid?someOtherId=123

    InformationsquelleAutor der Antwort Juri

  5. 3

    Mit Route("search/{categoryid=categoryid}/{ordercode=ordercode}") denen beide Abfragezeichenfolgen-und inline-route Parameter wie beantwortet mosharaf hossain. Schreiben Sie diese Antwort wie top-Antwort und beste Weg. Mit Route("") wird Probleme verursachen, wenn Sie mehrere Gets/Puts/Posts/Löscht.

    InformationsquelleAutor der Antwort bhargav kishore mummadireddy

  6. 2

    Hier ist eine leichte abweichend von @bhargav kishore mummadireddy ist Antwort, aber eine wichtige Abweichung. Seine Antwort wird standardmäßig die querystring-Werten zu einer tatsächlichen nicht-leeren Wert. Diese Antwort wird standardmäßig, Sie zu leeren.

    Es ermöglicht Ihnen das aufrufen des Controllers durch path-routing, oder verwenden Sie die querystring. Im wesentlichen, es definiert den default-Wert der querystring zu leeren, das heißt, es wird immer geroutet werden.

    Dies war mir wichtig, denn ich möchte zurückkehren, 400 (Bad Request) wenn ein querystring ist nicht angegeben, anstatt ASP.NET Rückkehr der "nicht finden konnte, diese Methode auf diesem controller" Fehler.

    [RoutePrefix("api/AppUsageReporting")]
public class AppUsageReportingController : ApiController
    {
        [HttpGet]
        //Specify default routing parameters if the parameters aren't specified
        [Route("UsageAggregationDaily/{userId=}/{startDate=}/{endDate=}")]
        public async Task<HttpResponseMessage> UsageAggregationDaily(string userId, DateTime? startDate, DateTime? endDate)
        {
            if (String.IsNullOrEmpty(userId))
            {
                return Request.CreateResponse(HttpStatusCode.BadRequest, $"{nameof(userId)} was not specified.");
            }

            if (!startDate.HasValue)
            {
                return Request.CreateResponse(HttpStatusCode.BadRequest, $"{nameof(startDate)} was not specified.");
            }

            if (!endDate.HasValue)
            {
                return Request.CreateResponse(HttpStatusCode.BadRequest, $"{nameof(endDate)} was not specified.");
            }
        }
    }

    InformationsquelleAutor der Antwort contactmatt

  7. 1

    Da haben Sie [Route("{name}/{drink}/{sport?}")] als Attribut-routing, dieser code wird nie erreicht werden.

    config.Routes.MapHttpRoute(
name: "NameRoute",
routeTemplate: "{verId}/Names/{name}/{sport}/{drink}",
defaults: new { name = RouteParameter.Optional, sport = RouteParameter.Optional, drink = RouteParameter.Optional },
constraints: new { verId = @"\d+" });

    Also nur das Attribut route [Route("{name}/{drink}/{sport?}")] wird geehrt hier. Da Ihre Anfrage localhost:12345/1/Names?name=Ted&sport=rugby&drink=cokenicht Namen -, sport-oder trinken in der URL ist es nicht passend zu diesem Attribut route. Betrachten wir die query-string-Parameter bei der Anpassung der Routen.

    Um dieses Problem zu lösen, müssen Sie alle 3 optional in Ihrem Attribut route. Dann wird es die Anforderung übereinstimmt.

    InformationsquelleAutor der Antwort mugdhak

  8. 0

    Benutze ich FromUri Attribut als Lösung

    [Route("UsageAggregationDaily")]
public async Task<HttpResponseMessage> UsageAggregationDaily([FromUri] string userId = null, [FromUri] DateTime? startDate = null, [FromUri] DateTime? endDate = null)

    InformationsquelleAutor der Antwort Vasil Galinovsky

Schreibe einen Kommentar