O que é uma API?
Uma API (sigla para Application Programming interface) é um conjunto de regras, padrões e ferramentas que permite que diferentes softwares se comuniquem entre si, ela funciona como ponte entre os sistemas e também define como os programas podem trocar informações e quais recursos estão disponíveis para uso, como exemplo podemos usar um restaurante, você é o cliente, a cozinha é o sistema que prepara os pratos (lógica interna) e o garçom é a API, que leva seu pedido até a cozinha e trás a comida pronta
Métodos HTTP e status code
Uma API web funciona usando requisições HTTP, e dentro delas entram dois pontos principais: os métodos e os status codes. Os métodos HTTP são verbos que dizem ao servidor o que queremos fazer com um recurso. Por exemplo, o GET serve para buscar informações, o POST cria algo novo, o PUT atualiza um recurso inteiro, o PATCH atualiza apenas uma parte dele e o DELETE remove. Já os status codes são as respostas que o servidor envia depois de receber a requisição, e eles indicam se deu certo ou se houve algum problema. Quando tudo funciona, podemos receber um 200 OK (requisição bem-sucedida), um 201 Created (quando algo foi criado com sucesso) ou um 204 No Content (quando deu certo, mas não há nada para devolver, como em um DELETE), 404 Not Found (quando o recurso não existe) e etc. Assim, os métodos dizem o que você quer fazer e os status codes dizem como o servidor respondeu.
Como criar uma API com expressJS
Para criar uma API com Express.js, você precisa ter o Node.js instalado. O Express é um framework para Node que facilita muito a criação de servidores e rotas. Um exemplo passo a passo:
No terminal:
mkdir minha-api
cd minha-api
npm init -y
npm install express
Criar o arquivo principal
Crie um arquivo chamado server.js (ou index.js) e coloque o seguinte código:
const express = require("express");
const app = express();
const port = 3000;
app.use(express.json());
app.get("/users", (req, res) => {
res.status(200).json([
{ id: 1, nome: "Ana" },
{ id: 2, nome: "João" }
]);
});
app.post("/users", (req, res) => {
const novoUsuario = req.body;
res.status(201).json({ mensagem: "Usuário criado", usuario: novoUsuario });
});
app.put("/users/:id", (req, res) => {
const { id } = req.params;
const dados = req.body;
res.status(200).json({ mensagem: Usuário ${id} atualizado, dados });
});
app.delete("/users/:id", (req, res) => {
const { id } = req.params;
res.status(204).send();
});
app.listen(port, () => {
console.log(🚀 Servidor rodando em http://localhost:${port});
});
No terminal:
node server.js
Agora sua API estará rodando em http://localhost:3000.
Top comments (0)