Esta é uma API simples para realizar operações CRUD (Create, Read, Update, Delete) em uma lista de pessoas. A API foi desenvolvida em Node.js utilizando o framework Express e TypeScript, e também inclui documentação Swagger para facilitar o entendimento das rotas disponíveis.
- Certifique-se de ter o Node.js instalado em sua máquina. Você pode baixá-lo aqui.
- Clone este repositório para o seu computador usando o seguinte comando:
git clone https://github.com/seu-usuario/api-pessoas.git - Navegue até o diretório do projeto:
cd api-pessoas - Instale as dependências do projeto utilizando o npm:
npm install
Para iniciar o servidor, execute o seguinte comando:
npm start
Isso iniciará o servidor na porta 3000 por padrão.
Para acessar a documentação Swagger, abra um navegador da web e navegue para o seguinte URL:
http://localhost:3000/api-docs
Isso exibirá a interface do Swagger UI, onde você poderá explorar a documentação da API e interagir com as rotas disponíveis.
- GET /pessoas: Retorna todas as pessoas.
- GET /pessoas/:id: Retorna uma pessoa pelo ID.
- POST /pessoas: Adiciona uma nova pessoa.
- PUT /pessoas/:id: Atualiza os dados de uma pessoa pelo ID.
- DELETE /pessoas/:id: Remove uma pessoa pelo ID.
Certifique-se de substituir localhost:3000 pelo host e porta onde o servidor está sendo executado, se estiver usando configurações diferentes.
- Express: Framework web rápido, não opinativo e minimalista para Node.js.
- TypeScript: Superset de JavaScript que adiciona tipagem estática à linguagem.
- Swagger UI Express: Middleware para servir a interface do Swagger UI no Express.
- Swagger JSDoc: Ferramenta para gerar documentação Swagger a partir de comentários JSDoc em código JavaScript/TypeScript.
- JSON Server: Simula um servidor RESTful a partir de um arquivo JSON.
Contribuições são bem-vindas! Sinta-se à vontade para abrir um problema ou enviar um pull request.
Este projeto está licenciado sob a MIT License.