API - orivaldosantana/mvp_banco_talentos GitHub Wiki

API é a sigla para Application Programming Interface, que em português significa Interface de Programação de Aplicações.

Uma API é um conjunto de regras e protocolos que especificam como diferentes softwares devem interagir entre si. Ela define os métodos e dados que um programa pode usar para se comunicar com outros programas, bibliotecas ou sistemas operacionais. Por exemplo, um aplicativo que precisa buscar dados de um servidor, a API desse servidor pode ser usada para fazer isso. A API do servidor define como realizar solicitações dos dados (como os URLs, os parâmetros, etc.) e como os dados serão retornados. Uma API atua como uma ponte entre diferentes softwares, permitindo que eles trabalhem juntos.

REST API

REST (Representational State Transfer) é um estilo arquitetural para a construção de serviços web. Uma API REST, também conhecida como RESTful API, é uma interface de programação de aplicações que adere aos princípios REST.

Aqui estão algumas características chave das APIs REST:

  1. Protocolo Cliente-Servidor: As APIs REST são baseadas na arquitetura cliente-servidor, onde o cliente e o servidor são entidades que interagem entre si. O cliente faz uma solicitação para o servidor, que processa a solicitação e retorna uma resposta.

  2. Stateless: Cada solicitação do cliente para o servidor deve conter todas as informações necessárias para entender e processar a solicitação. O servidor não deve armazenar nada sobre o estado mais recente do cliente entre as solicitações.

  3. Cacheable: As respostas do servidor podem ser armazenadas em cache no lado do cliente. Isso pode melhorar a velocidade e a eficiência da aplicação.

  4. Interface Uniforme: As APIs REST usam uma interface uniforme, que ajuda a desacoplar o cliente e o servidor e permite que cada um evolua independentemente.

As APIs REST normalmente usam HTTP como protocolo de comunicação e podem usar vários formatos de representação, como XML, JSON, etc. As operações HTTP comuns, como GET, POST, PUT, DELETE e PATCH, são usadas para ler, criar, atualizar e deletar recursos, respectivamente.

POST

O método POST é um dos métodos de solicitação HTTP, comumente usado para enviar dados para serem processados por um recurso do servidor.

A solicitação POST solicita ao servidor à aceitação os dados contidos no corpo da solicitação. O servidor processa os dados e retorna uma resposta, geralmente na forma de um recurso recém-criado ou uma representação do recurso atualizado. O método POST é frequentemente usado em operações de criação, onde o cliente precisa enviar dados para o servidor para criar um novo recurso. Por exemplo, em uma aplicação web, uma solicitação POST pode ser usada para enviar um formulário de inscrição para o servidor.

Exemplo de código POST no Next.js:

export const POST = async (req: Request) => {
  const requestData = await req.json()
  console.log(requestData)
  return Response.json({
    message: 'Cadastro realizado com sucesso!'
  })
}

Neste código, POST é uma função assíncrona usada para lidar com solicitações POST. A função recebe um objeto Request que representa a solicitação HTTP recebida pelo servidor.

Referências