Guia Básico para Criação de uma API

O Que É uma API?

API, ou Interface de Programação de Aplicações (Application Programming Interface), é um conjunto de regras e definições que permite que diferentes softwares se comuniquem entre si. Em termos simples, uma API permite que um aplicativo envie solicitações a outro aplicativo e receba respostas de volta. APIs são fundamentais na construção de aplicações modernas, pois permitem a integração de serviços e a troca de dados entre diferentes sistemas.

Por Que Usar uma API?

• Interoperabilidade: APIs permitem que diferentes sistemas, que podem ser escritos em diferentes linguagens de programação e executados em diferentes plataformas, se comuniquem entre si.
• Reusabilidade: Funções e dados podem ser reutilizados em diferentes aplicações, economizando tempo e esforço no desenvolvimento.
• Modularidade: Separar funcionalidades em diferentes serviços que podem ser acessados via APIs ajuda a criar sistemas mais modulares e escaláveis.

Como Funciona uma API?

Uma API web geralmente funciona através de requisições HTTP. O cliente (aplicação que faz a requisição) envia uma requisição HTTP para o servidor (aplicação que responde à requisição), e o servidor responde com os dados solicitados. Existem diferentes tipos de requisições HTTP, como GET, POST, PUT e DELETE, que são usados para diferentes operações:

• GET: Recupera dados do servidor.
• POST: Envia dados ao servidor para criar um novo recurso.
• PUT: Atualiza um recurso existente no servidor.
• DELETE: Remove um recurso do servidor.

Criando uma API Simples com Node.js e Express

Agora, vamos criar uma API simples usando Node.js e o framework Express. Esta API irá gerenciar uma lista de tarefas (to-do list).

Passo 1: Configuração do Ambiente

Primeiro, certifique-se de ter o Node.js instalado em sua máquina. Você pode baixar e instalar o Node.js a partir do site oficial: nodejs.org.

Passo 2: Criando o Projeto

Crie um novo diretório para o seu projeto e inicialize um novo projeto Node.js:

mkdir todo-api
cd todo-api
npm init -y

Passo 3: Instalando o Express

Instale o Express, um framework minimalista para Node.js que facilita a criação de servidores web:

Passo 4: Criando o Servidor

Crie um arquivo chamado app.js e adicione o seguinte código para configurar um servidor básico:

const express = require(‘express’);
const app = express();
const port = 3000;

app.use(express.json());

let todos = [];

app.get(‘/’, (req, res) => {
res.send(‘Bem-vindo à API de To-Do!’);
});

app.listen(port, () => {
console.log(Servidor rodando em http://localhost:${port});
});

Passo 5: Definindo Rotas da API

Adicione as seguintes rotas para criar, ler, atualizar e deletar tarefas na lista:

// Obter todas as tarefas
app.get(‘/todos’, (req, res) => {
res.json(todos);
});

// Criar uma nova tarefa
app.post(‘/todos’, (req, res) => {
const todo = req.body;
todos.push(todo);
res.status(201).json(todo);
});

// Atualizar uma tarefa
app.put(‘/todos/:id’, (req, res) => {
const id = parseInt(req.params.id);
const todoIndex = todos.findIndex(todo => todo.id === id);
if (todoIndex !== -1) {
todos[todoIndex] = req.body;
res.json(todos[todoIndex]);
} else {
res.status(404).send(‘Tarefa não encontrada’);
}
});

// Deletar uma tarefa
app.delete(‘/todos/:id’, (req, res) => {
const id = parseInt(req.params.id);
const todoIndex = todos.findIndex(todo => todo.id === id);
if (todoIndex !== -1) {
const deletedTodo = todos.splice(todoIndex, 1);
res.json(deletedTodo);
} else {
res.status(404).send(‘Tarefa não encontrada’);
}
});

Passo 6: Testando a API

Para testar a API, você pode usar uma ferramenta como o Postman ou cURL para enviar requisições HTTP ao servidor. Aqui estão alguns exemplos de como usar o cURL para testar as rotas:

• Obter todas as tarefas:
  curl -X GET http://localhost:3000/todos

• Criar uma nova tarefa:
  curl -X POST http://localhost:3000/todos -H “Content-Type: application/json” -d ‘{“id”: 1, “task”: “Aprender Node.js”}’

• Atualizar uma tarefa:
  curl -X PUT http://localhost:3000/todos/1 -H “Content-Type: application/json” -d ‘{“id”: 1, “task”: “Aprender Express.js”}’

• Deletar uma tarefa:
  curl -X DELETE http://localhost:3000/todos/1

Conclusão

Este guia básico mostrou como criar uma API simples usando Node.js e Express. APIs são uma parte crucial do desenvolvimento de aplicações modernas, permitindo a comunicação entre diferentes sistemas e serviços. Ao entender como funcionam e como criar uma API, você estará bem encaminhado para construir aplicações web poderosas e integradas.