Colocar documentações na Wiki do GitHub

[estevam5s]

Release 1.0 - Backend

Sprint 1 - Configuração do ambiente e desenvolvimento do modelo de dados

• [x] Configurar ambiente de desenvolvimento com as seguintes ferramentas:
  • Python 3.9
  • Flask 2.0.1
  • SQLAlchemy 1.4.22
• [x] Definir o modelo de dados da rentabilidade (produtos e seus atributos) usando SQLAlchemy

Sprint 2 - Implementação dos endpoints RESTful

• [x] Criar endpoint para consulta de todos os produtos cadastrados
• [x] Criar endpoint para consulta de um produto específico pelo ID
• [x] Criar endpoint para adicionar um novo produto
• [x] Criar endpoint para atualizar um produto existente pelo ID
• [x] Criar endpoint para deletar um produto existente pelo ID

Sprint 3 - Documentação e deploy da aplicação

• [x] Documentar a API RESTful no arquivo README.md
• [x] Configurar o servidor Flask para deploy da aplicação em ambiente de produção

Documentação da API RESTful

Consulta de todos os produtos

GET /api/produtos

Retorna a lista de todos os produtos cadastrados.

Parâmetros

Nenhum.

Respostas

Código	Descrição	Conteúdo
200	OK	Lista de produtos (JSON)
500	Internal Server Error	Mensagem de erro (JSON)

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "ID": 1,
    "Nome": "Produto A",
    "Preco": 10.99,
    "Quantidade": 100
  },
  {
    "ID": 2,
    "Nome": "Produto B",
    "Preco": 5.99,
    "Quantidade": 50
  }
]

Consulta de um produto específico

GET /api/produtos/{id}

Retorna as informações de um produto específico pelo ID.

Parâmetros

Parâmetro	Tipo	Descrição
id	int	ID do produto

Respostas

Código	Descrição	Conteúdo
200	OK	Informações do produto (JSON)
404	Not Found	Mensagem de erro (JSON)
500	Internal Server Error	Mensagem de erro (JSON)

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ID": 1,
  "Nome": "Produto A",
  "Preco": 10.99,
  "Quantidade": 100
}

Adição de um novo produto

POST /api/produtos

Adiciona um novo produto.

Parâmetros

Parâmetro	Tipo	Descrição
Nome	string	Nome do produto
Preco	float	Preço do produto
Quantidade	int	Quantidade em estoque do produto

Respostas

Código	Descrição	Conteúdo
201	Created	ID