https://github.com/luizfelipe9627/api-products-cd
Primeira atividade passada pelo Campinho Digital para treinar a criação de API utilizando Node.js e Express no Back.
https://github.com/luizfelipe9627/api-products-cd
expressjs javascript-es6 nodejs npm swagger-ui
Last synced: 3 months ago
JSON representation
Primeira atividade passada pelo Campinho Digital para treinar a criação de API utilizando Node.js e Express no Back.
- Host: GitHub
- URL: https://github.com/luizfelipe9627/api-products-cd
- Owner: luizfelipe9627
- License: mit
- Created: 2024-01-06T02:42:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-07T15:49:44.000Z (over 1 year ago)
- Last Synced: 2025-02-15T00:33:43.888Z (4 months ago)
- Topics: expressjs, javascript-es6, nodejs, npm, swagger-ui
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Documentação da API
## Sumário
- [Introdução](#introdução)
- [Requisitos](#requisitos)
- [Instalação](#instalação)
- [Visão geral da API](#visão-geral-da-api)
- [Documentação do Swagger](#documentação-do-swagger)
- [Recursos principais e Exemplos](#recursos-principais-e-exemplos)
- [1. Listar produtos](#1-listar-produtos)
- [2. Criar produto](#2-criar-produto)
- [3. Obter produto](#3-obter-produto)
- [4. Atualizar produto](#4-atualizar-produto)
- [5. Deletar produto](#5-deletar-produto)
## Introdução
Bem-vindo à documentação da API Products! Esta documentação fornece informações detalhadas sobre como usar a API, incluindo endpoints disponíveis, parâmetros aceitos, códigos de status e exemplos práticos. A documentação Swagger está disponível para uma visão mais interativa da API.
## Requisitos
- Node.js 14.15.1 ou superior.
- NPM 6.14.8 ou superior.
## Instalação
Para instalar e executar o projeto, siga os passos abaixo:
1. Clone o repositório
```bash
git clone https://github.com/luizfelipe9627/api-products-cd
```
2. Instale as dependências
```bash
npm install
```
3. Execute o projeto
```bash
npm run start
```
4. Acesse a documentação da API
```bash
http://localhost:3000/api-docs
```
## Visão geral da API
A API foi projetada para ser fácil e simples de usar. Abaixo estão alguns pontos importantes para começar:
- **Base URL**: O endpoint base para todas as chamadas da API é [http://localhost:3000].
- **Autenticação**: A API não requer autenticação.
- **Estrutura da resposta**: As respostas da API são retornadas em formato JSON. Os exemplos de resposta são fornecidos na documentação abaixo para cada endpoint.
- **Códigos de status**: A API retorna os seguintes códigos de status padrão: 200, 201, 400, 404 e 500. Códigos de status personalizados podem ser retornados em determinadas situações.
## Documentação do Swagger
Explore e teste a API de forma interativa usando a documentação local do Swagger. Acesse [link para a documentação do Swagger](http://localhost:3000/api-docs) para obter uma visão visual completa dos endpoints, parâmetros e exemplos. Só é possível acessar a documentação do Swagger localmente após a instalação e execução do projeto.
## Recursos principais e Exemplos
### 1. Listar produtos
Retorna uma lista de todos os produtos.
- **Endpoint**: `/products`
- **Método**: `GET`
**Exemplo de resposta:**
```json
[
{
"id": 1,
"name": "Smartphone",
"price": 499.99
},
{
"id": 2,
"name": "Notebook",
"price": 1299.99
}
]
```
### 2. Criar produto
Cria um novo produto.
- **Endpoint**: `/products`
- **Método**: `POST`
**Exemplo de corpo da solicitação:**
```json
{
"name": "Mouse sem fio",
"price": 29.99
}
```
**Exemplo de resposta:**
```json
{
{
"id": 3,
"name": "Mouse sem fio",
"price": 29.99,
}
}
```
### 3. Obter produto
Retorna um produto específico.
- **Endpoint**: `/products/:id`
- **Método**: `GET`
**Exemplo de resposta:**
```json
{
"id": 1,
"name": "Smartphone",
"price": 499.99
}
```
### 4. Atualizar produto
Atualiza um produto específico.
- **Endpoint**: `/products/:id`
- **Método**: `PUT`
**Exemplo de corpo da solicitação:**
```json
{
"name": "Notebook",
"price": 1299.99
}
```
**Exemplo de resposta:**
```json
{
"id": 2,
"name": "Video Game",
"price": 1999.99
}
```
### 5. Deletar produto
Deleta um produto específico.
- **Endpoint**: `/products/:id`
- **Método**: `DELETE`
**Exemplo de resposta:**
```json
{
"id": 2,
"name": "Video Game",
"price": 1999.99,
}
```