Kann mir jemand CreatedAtRoute () erklären?

In der Vorlage für Web API 2 lautet eine Post-Methode immer wie folgt:

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

Ich verstehe diese CreatedAtRoute()Methode nicht. Kann CreatedAtRoute()mir jemand die Methode erklären ?

Die CreatedAtRouteMethode soll einen URI an die neu erstellte Ressource zurückgeben, wenn Sie eine POST-Methode aufrufen, um ein neues Objekt zu speichern. Wenn Sie beispielsweise eine Bestellposition POSTEN, können Sie eine Route wie 'api / order / 11' zurückgeben (11 ist offensichtlich die ID der Bestellung).

Übrigens stimme ich zu, dass der MSDN-Artikel für das Verständnis von Nutzen ist. Die Route, die Sie tatsächlich zurückgeben, hängt natürlich von Ihrem Routing-Setup ab.

Wenn Sie CreatedAtRoute verwenden, ist das erste Argument der Methodenname von Get to the resource. Der nicht so offensichtliche Trick besteht darin, dass Sie trotz des angegebenen korrekten Methodennamens den Parameter Name für das HttpGet-Attribut verwenden müssen, damit er funktioniert.

Wenn die Rückgabe in Ihrem Beitrag also wie folgt lautet:

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

Dann sollte Ihr Get-Methodenattribut so aussehen, auch wenn Ihre Methode Get heißt:

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

Aufrufe Ihrer Post-Methode geben nicht nur das neue Objekt zurück (normalerweise als JSON), sondern setzen auch den Location-Header für die Antwort auf den URI, der diese Ressource erhalten würde.

In .net Core WebAPI verwenden Sie diese Methode, um einen 201-Code zurückzugeben. Dies bedeutet, dass das Objekt erstellt wurde.

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.CreatedAtRouteResult CreatedAtRoute (string routeName, object routeValues, object content);

Wie Sie oben sehen können, kann die CreatedAtRoute 3 Parameter empfangen:

routeName Ist der Name, den Sie für die Methode eingeben müssen, die der URI ist, der diese Ressource nach der Erstellung erhält.

routeValues ​​Dies ist das Objekt, das die Werte enthält, die an der benannten Route an die GET-Methode übergeben werden. Es wird verwendet, um das erstellte Objekt zurückzugeben

Inhalt Es ist das Objekt, das erstellt wurde.

Das obige Beispiel zeigt die Implementierung von zwei Methoden eines einfachen Controllers mit einer einfachen GET-Methode mit dem verbundenen Namen und der POST-Methode, die ein neues Objekt erstellt.

namespace BastterAPI.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class CompanyController : Controller
    {
        private ICompanyRepository _companyRepository;

        public CompanyController(ICompanyRepository companyRepository)
        {
            _companyRepository = companyRepository;
        }

        [HttpGet("{id}", Name="GetCompany")]
        public IActionResult GetById(int id)
        {
            Company company = _companyRepository.Find(id);

            if (company == null)
            {
                return NotFound();
            }

            return new ObjectResult(company);

        }

        [HttpPost]
        public IActionResult Create([FromBody] Company company)
        {

            if (company == null)
            {
                return BadRequest();
            }

            _companyRepository.Add(company);

            return CreatedAtRoute("GetCompany", new Company { CompanyID = company.CompanyID }, company);

        }


    }
}

WICHTIG

1. Beachten Sie, dass der erste Parameter bei CreatedAtRoute (routeName) bei der Definition des Namens bei der Get-Methode identisch sein muss.

2. Das Objekt im zweiten Parameter muss über die erforderlichen Felder verfügen, die Sie zum Abrufen der Ressource in der Get-Methode verwenden. Sie können sagen, dass es sich um eine Teilmenge des selbst erstellten Objekts handelt

3. Der letzte Parameter ist das Firmenobjekt, das in der Textanforderung in seiner vollständigen Form empfangen wurde.

ENDLICH

Als letztes Ergebnis, wenn der Beitrag zum Erstellen einer neuen Firma für diese API erstellt wurde, geben Sie eine Route wie 'api / company / {id}' zurück, die Ihnen die neu erstellte Ressource zurückgibt