Esta é uma API simples construída usando o framework Express.js para Node.js e documentada com a ferramenta Swagger. A API simula operações básicas CRUD (Criar, Ler, Atualizar e Excluir) em uma lista de produtos. Exemplo utilizado para colegas de turma.
- Node.js
- npm (gerenciador de pacotes do Node.js)
git clone https://github.com/lucivandosousa/api-express-array.git
npm install
Para iniciar a API, execute o seguinte comando:
npm run prod
A API será executada na porta 3000 por padrão, ou na porta especificada pela variável de ambiente PORT.
-
GET "/" Retorna uma mensagem indicando que a API está funcionando.
-
POST "/produtos" Adiciona um novo produto à lista de produtos.
-
GET "/produtos" Retorna a lista completa de produtos.
-
GET "/produtos/:id" Retorna um produto específico com base no ID fornecido.
-
PUT "/produtos/:id" Atualiza um produto específico com base no ID fornecido.
-
DELETE "/produtos/:id" Exclui um produto específico com base no ID fornecido.
-
GET "/api-docs" Exibe a interface gráfica do Swagger UI.
Para adicionar um novo produto, você pode enviar uma requisição POST com os detalhes do produto no corpo da requisição:
{
"id": 4,
"descricao": "Produto 4"
}