Quelqu'un peut-il expliquer CreatedAtRoute() pour moi?

À partir du modèle de l'API Web 2, une méthode post est toujours comme ça:

[ResponseType(typeof(MyDTO))]
public IHttpActionResult PostmyObject(MyDTO myObject)
{
    ...
    return CreatedAtRoute("DefaultApi", new { id = myObject.Id }, myObject);
}

Je ne comprends pas ce CreatedAtRoute() méthode. Quelqu'un peut-il expliquer la CreatedAtRoute() méthode à moi?

  • bien sûr, je trouve ces résultats Google. Mon problème est que ces documents ne m'aident pas à comprendre cette méthode, après les avoir lu, je ne comprends toujours pas. C'est pourquoi je demande ici.
  • Je n'ai pas à vous répondre à ma question alors.
  • Si je peux Google et trouver la réponse, pourquoi ai-je pris la peine de passer du temps à modifier une question et demandez ici?
  • merci de poser cette question 🙂
  • moi aussi! merci!
InformationsquelleAutor martial | 2014-07-30
  1. 145

    La CreatedAtRoute méthode est prévue pour retourner un URI de la ressource nouvellement créée lorsque vous appelez une méthode POST pour stocker un nouvel objet.
    Donc, si vous publiez un article, par exemple, vous pourriez retourner une route comme 'api/commande/11' (11 étant l'id de la commande évidemment).

    BTW je suis d'accord que l'article MSDN est d'aucune utilité dans la compréhension de ce. L'itinéraire vous fait retour va naturellement dépendre de votre configuration du routing.

    • Je vous remercie. C'est très utile. Mais quand je l'ai testé sur le Facteur, j'ai vu ce qui est renvoyée de myObject, pas la route?
    • De quoi il en retourne est en fait un CreatedAtRouteNegotiatedContentResult<monobjet> objet! C'est ce que vous verrez si vous exécutez un test unitaire sur votre action. Toutefois, lorsqu'il est exécuté dans le contexte du protocole http, ce sera le retour de l'objet sérialisé dans le corps, mais vous devriez voir une tête dans la réponse avec le lien vers la ressource. BTW, si vous pensez que j'ai répondu à la question, pourriez-vous marquer comme réponse? Des acclamations.
    • Merci, cela répond à ma question.
    • L'itinéraire que vous avez fournies apparaît comme un Lieu d'en-tête dans la réponse. C'est assez typique de REPOS comportement
    • Pourquoi dois-je retourner MyObject dans le CreatedAtRoute, déjà sur le client... que l'Id est de nouveau qui est déjà dans le type anonyme?!
    • Monobjet est pas retourné par CreatedAtRoute - il suffit de l'URI de la ressource. Cela permettra d'inclure l'Id, que le client ne le sait pas encore (au moins dans un scénario typique où la db génère de l'id), et c'est le but principal de la méthode. C'est la norme avec le REPOS de retour que lors de la Publication d'une nouvelle ressource, mais il n'est pas obligatoire ou quoi que ce soit. Si vous n'en avez pas besoin, vous pouvez simplement retourner un 201.
    • Lorsque le Monobjet est pas retourné, MAIS... pourquoi dois-je passer à la CreatedAtRoute? Quelle est la méthode à faire avec elle?
    • Ok ce genre de réponses à la question pour le cas simple, mais comment à propos d'un cas plus complexe? Comment pourrais-je appeler CreatedAtRoute lorsque l'URI je veux le retour est /api/Clients/{idclient}/Commande/{n°}?
    • Voici un autre lien une question à propos de CreatedAtRoute qui parle de nommage des routes lorsque vous utilisez les attributs (c'est à dire par des voies complexes comme le client l'exemple que j'ai donné.) Il a résolu mon problème avec le remplissage de ces deux paramètres.
    • Est-il possible d'utiliser de la route actuelle? Par exemple, si je crée un objet dans les fichiers de contrôleur à l'aide d' [Route("[controller]")] sur le contrôleur, que dois-je retourner (de sorte que le adjacents OBTENIR une action peut être invoquée par l'URL, par exemple)?
    • Lors de la réponse à Elisabeth, vous dites que MyObject n'est pas retourné par CreatedAtRoute. Si, dans un commentaire que vous avez fait précédemment dans ce fil, vous dire qu'il est retourné en forme sérialisée dans le corps. Pourriez-vous éclaircir sur ce point? Ai-je raison de penser que les deux d'un URI de la ressource, et la ressource elle-même (dans le corps) est transmis au client à partir de la CreatedAtRoute appel? Si oui, quel est le point de y compris les deux?
    • bonne question. C'est un long temps depuis que j'ai écrit cette réponse et je n'ai pas travaillé avec l'API Web pour un certain temps, mais oui, CreatedAtRoute retourne l'emplacement comme un en-tête et l'objet lui-même dans le corps. De sorte que le commentaire de Elisabeth avait tort, il me semble. Sur le but, j'imagine qu'avec une requête POST (par opposition à un), il se peut que le serveur crée un objet qui n'est pas simplement ce que le client a envoyé, et le client peuvent être intéressés, et pas envie d'avoir à faire une deuxième demande pour le retour de l'emplacement de l'URI.

    InformationsquelleAutor see sharper
  2. 0

    Lorsque vous utilisez CreatedAtRoute, le premier argument est le nom de la méthode de l'Obtenir à la ressource. Le truc qui n'est pas si évident, c'est que, même avec la bonne méthode, nom spécifié, vous devez utiliser le Nom de param sur le HttpGet attribut pour que cela fonctionne.

    Donc, si le retour dans votre Post, c'est ceci:

    return CreatedAtRoute("Get", new { newModel.Id}, newModel);

    Alors votre méthode Get attribut devrait ressembler à ceci même si votre méthode est appelée Get:

    [HttpGet("{id}", Name = "Get")]

    Ce ne sera pas seulement de retour le nouvel objet (normalement JSON), il va définir l'Emplacement de l'en-tête de la réponse à l'URI qui permettrait d'obtenir cette ressource.

    InformationsquelleAutor Scott Blasingame