Uma REST API é uma forma comum de projetar uma API web em torno de recursos, como usuários, problemas ou pedidos. Cada recurso recebe uma URL, e métodos HTTP como GET, POST, PATCH e DELETE dizem ao servidor o que o cliente quer fazer.

REST significa Representational State Transfer. Na prática, um cliente envia uma requisição HTTP, o servidor retorna uma representação de um recurso, e cada requisição deve fazer sentido por si só. Muitas REST APIs retornam JSON, mas JSON sozinho não torna uma API RESTful.

Significado de REST API: pense em recursos

A forma mais rápida de entender REST é pensar em substantivos, não em verbos.

Se o seu sistema tem problemas, estudantes e tentativas, esses podem ser recursos. Uma API orientada a recursos tende a usar URLs como /api/problems/42 ou /api/attempts/9001.

O método HTTP então informa que tipo de operação está acontecendo:

  • GET lê um recurso
  • POST cria um novo recurso
  • PUT substitui um recurso
  • PATCH atualiza parte de um recurso
  • DELETE remove um recurso

Essa separação é o que torna REST fácil de entender rapidamente. A URL diz com o que você está trabalhando. O método diz o que você quer fazer.

Como funciona uma requisição em uma REST API

Em um fluxo típico, um navegador, aplicativo mobile ou outro serviço envia uma requisição para um servidor. A requisição inclui uma URL, um método HTTP, cabeçalhos opcionais e, às vezes, um corpo.

O servidor lê a requisição, executa a ação e retorna uma resposta. Essa resposta geralmente inclui um código de status como 200 OK, 201 Created ou 404 Not Found, além de dados que descrevem o resultado.

Uma condição importante é a statelessness. Em REST, cada requisição deve conter o contexto necessário para aquela requisição. Isso não significa que o servidor não armazena dados. Significa que o servidor não deve precisar de um estado oculto de conversa de requisições anteriores para entender a atual.

Exemplo de REST API: um app de prática de matemática

Suponha que um app de prática de matemática armazene problemas de álgebra e tentativas dos estudantes.

Para ler o problema 4242, o cliente pode enviar:

Precisa de ajuda com um problema?

Envie sua pergunta e receba uma solução verificada, passo a passo, em segundos.

Abrir GPAI Solver →