Recursos y URL
Parte de la sección API REST del Journey de ASP.NET Core de Coddy. Lección 1 de 20.
Otros programas llaman a tu API, así que sus URL deben ser fáciles de adivinar. La mayoría de las API web siguen un estilo llamado REST: cada URL nombra un recurso, algo que la API almacena, y el método HTTP indica qué hacer con él.
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 7Las rutas contienen sustantivos, nunca verbos: con /api/getInvoice?id=7, cada cliente debe aprender una palabra nueva para cada acción. La colección tiene un nombre en plural, y un elemento es la ruta de la colección más su 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} es un parámetro de ruta con una restricción: solo coincide con números enteros, así que /api/invoices/abc no coincide con ninguna ruta y responde con 404. Un id que no coincide con ninguna factura también responde con 404, mediante Results.NotFound().
Desafío
FácilEn esta sección, crearás una API de seguimiento de tareas. Empieza con tres tareas y GET /api/tasks, que las devuelve todas. Las tareas son registros TaskItem, porque .NET ya tiene un tipo llamado Task. Añade la URL para una tarea.
- En
Program.cs, debajo deGET /api/tasks, asignaGET /api/tasks/{id:int}. - Busca la tarea cuyo
Idsea igual aidcontasks.Findy devuélvela conResults.Ok(task).GET /api/tasks/2devuelve:{ "id": 2, "title": "Book the meeting room", "done": true } - Cuando ninguna tarea tenga ese id, devuelve
Results.NotFound(): estado 404 con un cuerpo vacío.
Pruébalo: pulsa «Ejecutar». La columna envía GET /api/tasks y muestra las tres tareas. Envía GET /api/tasks/2: 200 y la tarea de arriba. Envía GET /api/tasks/99: 404. Envía GET /api/tasks/abc: también 404, porque {id:int} solo coincide con números.
Pruébalo tú mismo
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);
Esta lección incluye un breve cuestionario. Empieza la lección para responderlo y registrar tu progreso.
Todas las lecciones de API REST
1Recursos y verbos
Recursos y URLCrear con POST2Validación y errores
Rechazar entradas no válidas5Navegadores y alojamiento
CORS