Criando um servidor básico com NodeJS: Testando e documentando a API

Desenvolver uma API em NodeJS envolve várias etapas, desde a configuração do ambiente até a implementação de rotas e testes. Neste capítulo, vamos focar na criação de um servidor básico em NodeJS e como testar e documentar a API.

Configurando o Servidor

O primeiro passo é configurar o servidor. Para isso, precisamos instalar o NodeJS e o NPM (Node Package Manager) em nosso sistema. Após a instalação, criamos um novo diretório para o nosso projeto e inicializamos um novo projeto NodeJS com o comando

npm init

. Isso criará um arquivo package.json, que será usado para gerenciar as dependências do nosso projeto.

Agora, vamos instalar o Express, um framework para NodeJS que simplifica o desenvolvimento de servidores web. Para instalar o Express, usamos o comando

npm install express

.

Com o Express instalado, podemos criar nosso servidor básico. Criamos um novo arquivo chamado server.js e nele, importamos o Express e iniciamos uma nova aplicação. Em seguida, definimos uma rota básica que responde com um "Hello, World!" quando acessada.

        const express = require('express');
        const app = express();

        app.get('/', (req, res) => {
            res.send('Hello, World!');
        });

        app.listen(3000, () => {
            console.log('Server is running on port 3000');
        });
        

Testando a API

Com o servidor criado, o próximo passo é testar a API. Para isso, usaremos o Postman, uma ferramenta que permite enviar requisições HTTP para um servidor e visualizar as respostas.

Para testar a rota que criamos, abrimos o Postman, selecionamos o método GET, inserimos a URL do servidor (http://localhost:3000) e clicamos em "Send". Se tudo estiver funcionando corretamente, deveremos ver a mensagem "Hello, World!" na resposta.

Documentando a API

A documentação é uma parte crucial de qualquer API. Ela permite que outros desenvolvedores entendam como usar a API e quais recursos estão disponíveis. A documentação deve incluir informações sobre as rotas, os métodos HTTP suportados, os parâmetros esperados e os possíveis códigos de status e respostas.

Existem várias ferramentas disponíveis para documentar APIs, como o Swagger e o API Blueprint. Essas ferramentas permitem criar documentação interativa que pode ser facilmente atualizada conforme a API evolui. Para usar o Swagger, por exemplo, precisamos instalar o módulo swagger-ui-express e criar um arquivo JSON com a especificação da API.

Com todas essas etapas concluídas, temos um servidor básico em NodeJS com uma API testada e documentada. No entanto, este é apenas o início. À medida que a API cresce, precisaremos adicionar autenticação, lidar com erros, implementar testes automatizados e muito mais. Mas com uma base sólida, estamos bem preparados para enfrentar esses desafios.