Menu
CoddyTech

Recursos e URLs

Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 1 de 20.

Outros programas chamam sua API, então as URLs devem ser fáceis de adivinhar. A maioria das APIs da web segue um estilo chamado REST: cada URL nomeia um recurso, algo que a API armazena, e o método HTTP diz o que fazer com ele.

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

Os caminhos contêm substantivos, nunca verbos: com /api/getInvoice?id=7, cada cliente precisa aprender uma palavra nova para cada ação. A coleção tem um nome no plural, e um item é o caminho da coleção mais seu 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} é um parâmetro de rota com uma restrição: ele corresponde apenas a números inteiros, então /api/invoices/abc não corresponde a nenhuma rota e retorna 404. Um id que não corresponde a nenhuma fatura também retorna 404, por meio de Results.NotFound().

challenge icon

Desafio

Fácil

Nesta seção, você vai criar uma API de rastreamento de tarefas. Ela começa com três tarefas e GET /api/tasks, que retorna todas elas. As tarefas são registros TaskItem, porque o .NET já tem um tipo chamado Task. Adicione a URL de uma tarefa.

  1. Em Program.cs, abaixo de GET /api/tasks, mapeie GET /api/tasks/{id:int}.
  2. Encontre a tarefa cujo Id é igual a id usando tasks.Find e retorne-a com Results.Ok(task). GET /api/tasks/2 retorna:
    { "id": 2, "title": "Book the meeting room", "done": true }
  3. Quando nenhuma tarefa tiver esse id, retorne Results.NotFound(): status 404 com o corpo vazio.

Teste: pressione Executar. A coluna envia GET /api/tasks e mostra as três tarefas. Envie GET /api/tasks/2: 200 e a tarefa acima. Envie GET /api/tasks/99: 404. Envie GET /api/tasks/abc: também 404, porque {id:int} corresponde apenas a números.

Experimente você mesmo

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 iconTeste seus conhecimentos

Esta lição inclui um quiz rápido. Comece a lição para respondê-lo e acompanhar seu progresso.

Todas as lições de APIs REST