Menu
CoddyTech

Risorse e URL

Fa parte della sezione API REST del percorso ASP.NET Core di Coddy. Lezione 1 di 20.

Altri programmi chiamano la tua API, quindi i suoi URL dovrebbero essere facili da indovinare. La maggior parte delle API web segue uno stile chiamato REST: ogni URL indica una risorsa, ovvero qualcosa che l'API memorizza, e il metodo HTTP specifica cosa fare con essa.

GET    /api/invoices      the list of invoices
GET    /api/invoices/7    invoice 7
POST   /api/invoices      add an invoice
DELETE /api/invoices/7    remove invoice 7

I percorsi contengono sostantivi, mai verbi: con /api/getInvoice?id=7, ogni client deve imparare una nuova parola per ogni azione. La raccolta ha un nome plurale e un singolo elemento corrisponde al percorso della raccolta più il suo id.

app.MapGet("/api/invoices/{id:int}", (int id) =>
{
    var invoice = invoices.Find(i => i.Id == id);
    return invoice is null ? Results.NotFound() : Results.Ok(invoice);
});

{id:int} è un parametro di route con un vincolo: corrisponde solo ai numeri interi, quindi /api/invoices/abc non corrisponde ad alcuna route e restituisce 404. Anche un id che non corrisponde ad alcuna fattura restituisce 404, tramite Results.NotFound().

challenge icon

Sfida

Facile

In questa sezione costruisci un'API per tenere traccia delle attività. Inizia con tre attività e GET /api/tasks, che le restituisce tutte. Le attività sono record TaskItem, perché .NET ha già un tipo chiamato Task. Aggiungi l'URL per una singola attività.

  1. In Program.cs, sotto GET /api/tasks, mappa GET /api/tasks/{id:int}.
  2. Trova l'attività il cui Id è uguale a id con tasks.Find e restituiscila con Results.Ok(task). GET /api/tasks/2 restituisce:
    { "id": 2, "title": "Book the meeting room", "done": true }
  3. Se nessuna attività ha quell'id, restituisci Results.NotFound(): stato 404 con corpo vuoto.

Prova: premi Esegui. La colonna invia GET /api/tasks e mostra le tre attività. Invia GET /api/tasks/2: 200 e l'attività sopra. Invia GET /api/tasks/99: 404. Invia GET /api/tasks/abc: anche in questo caso 404, perché {id:int} corrisponde solo ai numeri.

Provalo tu

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

var tasks = new List<TaskItem>
{
    new(1, "Write the project brief", false),
    new(2, "Book the meeting room", true),
    new(3, "Send the invoice", false),
};

app.MapGet("/api/tasks", () => tasks);

app.Run();

record TaskItem(int Id, string Title, bool Done);
quiz iconMettiti alla prova

Questa lezione include un breve quiz. Inizia la lezione per rispondere e tenere traccia dei tuoi progressi.

Tutte le lezioni di API REST