Übung: Hinzufügen eines Controllers

5 Minuten

Ein Controller ist eine öffentliche Klasse mit einer oder mehreren öffentlichen Methoden, die als Aktionen bezeichnet werden. Standardmäßig wird ein Controller im Verzeichnis "Controller" des Projekts platziert. Die Aktionen werden im Web-API-Controller als HTTP-Endpunkte zur Verfügung gestellt.

Erstellen eines Controllers

Wählen Sie den Ordner "Controller" in Visual Studio Code aus, und fügen Sie eine neue Datei namens PizzaController.cs hinzu.

Eine leere Klassendatei mit dem Namen PizzaController.cs wird im Verzeichnis "Controller" erstellt. Der Verzeichnisname Controllers ist eine Konvention. Der Verzeichnisname stammt aus der Modellansichtscontrollerarchitektur , die von der Web-API verwendet wird.

Hinweis

Standardmäßig werden Controllerklassennamen mit Controller suffixiert.
Fügen Sie den folgenden Code zu Controllern/PizzaController.cs hinzu. Speichern Sie die Änderungen.
```
using ContosoPizza.Models;
using ContosoPizza.Services;
using Microsoft.AspNetCore.Mvc;

namespace ContosoPizza.Controllers;

[ApiController]
[Route("[controller]")]
public class PizzaController : ControllerBase
{
    public PizzaController()
    {
    }

    // GET all action

    // GET by Id action

    // POST action

    // PUT action

    // DELETE action
}
```
Wie Sie zuvor gelernt haben, wird diese Klasse von ControllerBase abgeleitet, der Basisklasse für das Arbeiten mit HTTP-Anforderungen in ASP.NET Core. Darin sind auch die beiden Standardattribute enthalten, die Sie kennengelernt haben: [ApiController] und [Route]. Wie zuvor definiert das [Route]-Attribut eine Zuordnung zum [controller]-Token. Da diese Controllerklasse PizzaController heißt, verarbeitet dieser Controller Anforderungen an https://localhost:{PORT}/pizza.

Abrufen aller Pizzadaten

Das erste REST-Verb, das Sie implementieren müssen, ist GET, wodurch ein Client alle Pizzadaten aus der API abrufen kann. Mit dem integrierten [HttpGet]-Attribut können Sie eine Methode definieren, die die Pizzadaten aus unserem Dienst zurückgibt.

Ersetzen Sie den // GET all action Kommentar in Controller/PizzaController.cs durch den folgenden Code:

[HttpGet]
public ActionResult<List<Pizza>> GetAll() =>
    PizzaService.GetAll();

Die vorherige Aktion:

Reagiert nur auf das HTTP-Verb GET, wie durch das [HttpGet]-Attribut angegeben.
Gibt eine ActionResult-Instanz vom Typ List<Pizza> zurück. Der ActionResult-Typ ist die Basisklasse für alle Aktionsergebnisse ASP.NET Core.
Fragt den Dienst nach allen Pizzadaten ab, und gibt automatisch Daten mit dem Content-Type-Wert von application/json zurück.

Abrufen eines einzelnen Pizzadatensatzes

Der Client möchte möglicherweise auch Informationen zu einer bestimmten Pizza anstelle der gesamten Liste anfordern. Sie können eine weitere GET-Aktion implementieren, die einen id-Parameter erfordert. Mit dem integrierten [HttpGet("{id}")]-Attribut können Sie eine Methode definieren, die die Pizzadaten aus unserem Dienst zurückgibt. Die Routinglogik registriert [HttpGet] (ohne id) und [HttpGet("{id}")] (mit id) als zwei verschiedene Routen. Anschließend können Sie eine separate Aktion schreiben, um ein einzelnes Element abzurufen.

Ersetzen Sie den // GET by Id action Kommentar in Controller/PizzaController.cs durch den folgenden Code:

[HttpGet("{id}")]
public ActionResult<Pizza> Get(int id)
{
    var pizza = PizzaService.Get(id);

    if(pizza == null)
        return NotFound();

    return pizza;
}

Die vorherige Aktion:

Reagiert nur auf das HTTP-Verb GET, wie durch das [HttpGet]-Attribut angegeben.
Erfordert, dass der Wert des Parameters id im URL-Segment hinter pizza/ eingefügt wird. Beachten Sie, dass das [Route]-Attribut auf Controllerebene das /pizza-Muster definiert hat.
Fragt die Datenbank nach einer Pizza ab, die mit dem angegebenen id-Parameter übereinstimmt.

Jede in der Aktion oben verwendete ActionResult-Instanz wird in der folgenden Tabelle dem entsprechenden HTTP-Statuscode zugeordnet:

ASP.NET Core Aktionsergebnis	HTTP-Statuscode	BESCHREIBUNG
impliziert `Ok`	200	Ein Produkt, das mit dem angegebenen `id`-Parameter übereinstimmt, ist im In-Memory-Cache enthalten. Das Produkt ist wie im HTTP-Anforderungsheader `accept` (standardmäßig JSON) definiert im Antworttext im Medientyp enthalten.
`NotFound`	404	Ein Produkt, das mit dem angegebenen `id`-Parameter übereinstimmt, ist nicht im In-Memory-Cache enthalten.

Erstellen und Ausführen des neuen Controllers

Erstellen und starten Sie die Web-API, indem Sie den folgenden Befehl ausführen:

dotnet run

Testen des Controllers mit einer HTTP-Datei

Öffnen von ContosoPizza.http
Fügen Sie einen neuen GET hinzu, um den Pizza Endpunkt unter dem ### Seperator aufzurufen:
```
GET {{ContosoPizza_HostAddress}}/pizza/
Accept: application/json

###
```

Wählen Sie den Befehl "Anforderung senden" oberhalb dieses neuen GET-Aufrufs aus.

Der vorherige Befehl gibt eine Liste aller Pizzas in JSON zurück:

HTTP/1.1 200 OK
Connection: close
Content-Type: application/json; charset=utf-8
Date: Wed, 17 Jan 2024 16:57:09 GMT
Server: Kestrel
Transfer-Encoding: chunked

[
    {
        "id": 1,
        "name": "Classic Italian",
        "isGlutenFree": false
    },
    {
        "id": 2,
        "name": "Veggie",
        "isGlutenFree": true
    }
]

Zum Abfragen eines einzelnen Pizzadatensatzes können Sie eine weitere GET-Anforderung ausgeben, aber mit dem folgenden Befehl einen id-Parameter übergeben:

GET {{ContosoPizza_HostAddress}}/pizza/1
Accept: application/json

###

Der Befehl oben gibt Classic Italian mit der folgenden Ausgabe zurück:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 02 Apr 2021 21:57:57 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "id": 1,
    "name": "Classic Italian",
    "isGlutenFree": false
}

Unsere API verarbeitet auch Fälle, in denen das Element nicht vorhanden ist. Rufen Sie die API erneut auf, übergeben Sie aber mit dem folgenden Befehl einen ungültigen id-Parameter für eine Pizza:

GET {{ContosoPizza_HostAddress}}/pizza/5
Accept: application/json

###

Der vorherige Befehl gibt einen Fehler 404 Not Found mit der folgenden Ausgabe zurück:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json; charset=utf-8
Date: Fri, 02 Apr 2021 22:03:06 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-ec263e401ec554b6a2f3e216a1d1fac5-4b40b8023d56762c-00"
}

Sie haben die Implementierung der GET-Verben abgeschlossen. In der nächsten Lerneinheit können Sie PizzaController weitere Aktionen hinzufügen, um CRUD-Vorgänge für Pizzadaten zu unterstützen.

Optional: Testen des Controllers mit dem HTTP REPL (read–eval–print-Loop) der Befehlszeile

Öffnen Sie das vorhandene httprepl Terminal, oder öffnen Sie ein neues integriertes Terminal aus Visual Studio Code, indem Sie im Hauptmenü " Terminal>Neues Terminal " auswählen.
Stellen Sie mithilfe des folgenden Befehls eine Verbindung mit einer Web-API her:
```
httprepl https://localhost:{PORT}
```
Alternativ können Sie den folgenden Befehl jederzeit ausführen, während HttpRepl ausgeführt wird:
```
connect https://localhost:{PORT}
```
Führen Sie den folgenden Befehl aus, um den neu verfügbaren Pizza-Endpunkt anzuzeigen:
```
ls
```
Mit dem vorherigen Befehl werden alle APIs erkannt, die für den verbundenen Endpunkt verfügbar sind. Es sollten der folgende Code angezeigt werden:
```
 https://localhost:{PORT}/> ls
 .                 []
 Pizza             [GET]
 WeatherForecast   [GET]
```
Navigieren Sie zum Pizza-Endpunkt, indem Sie den folgenden Befehl ausführen:
```
cd Pizza
```
Der vorherige Befehl zeigt eine Ausgabe der verfügbaren APIs für den Pizza-Endpunkt an:
```
https://localhost:{PORT}/> cd Pizza
/Pizza    [GET]
```

Senden Sie mithilfe des folgenden Befehls eine GET-Anforderung in HttpRepl:

get

Der vorherige Befehl gibt eine Liste aller Pizzas in JSON zurück:

  HTTP/1.1 200 OK
  Content-Type: application/json; charset=utf-8
  Date: Fri, 02 Apr 2021 21:55:53 GMT
  Server: Kestrel
  Transfer-Encoding: chunked

  [
      {
          "id": 1,
          "name": "Classic Italian",
          "isGlutenFree": false
      },
      {
          "id": 2,
          "name": "Veggie",
          "isGlutenFree": true
      }
  ]

Zum Abfragen eines einzelnen Pizzadatensatzes können Sie eine weitere GET-Anforderung ausgeben, aber mit dem folgenden Befehl einen id-Parameter übergeben:

get 1

Der Befehl oben gibt Classic Italian mit der folgenden Ausgabe zurück:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 02 Apr 2021 21:57:57 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "id": 1,
    "name": "Classic Italian",
    "isGlutenFree": false
}

get 5

Der vorherige Befehl gibt einen Fehler 404 Not Found mit der folgenden Ausgabe zurück:

HTTP/1.1 404 Not Found
Content-Type: application/problem+json; charset=utf-8
Date: Fri, 02 Apr 2021 22:03:06 GMT
Server: Kestrel
Transfer-Encoding: chunked

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-ec263e401ec554b6a2f3e216a1d1fac5-4b40b8023d56762c-00"
}

Kehren Sie in der Dropdownliste in Visual Studio Code zum dotnet-Terminal zurück, und fahren Sie die Web-API herunter, indem Sie auf Ihrer Tastatur STRG+C drücken.

Feedback

War diese Seite hilfreich?