Mercado autônomo

Introdução

Recebemos uma demanda para realizar a criação de uma API REST. Essa API será utilizada para organização do estoque de uma startup em processo de testes que pretende se transformar em uma rede de mercados autônomos (Smart Store). Hoje o mercado trabalha com apenas dois tipos de produtos: comida e limpeza.

Como iremos controlar o estoque do mercado, nossa aplicação deverá ter rotas para a criação, listagem, atualização e deleção de produtos.

Vamos colocar a mão ~~na massa~~ no código!

O repositório da entrega conta com o arquivo chamado *market_workspace*. Esse arquivo é um documento de design utilizado no *insomnia*.
Ele contém todas as rotas necessárias para que a aplicação esteja de acordo com as regras impostas.
Esse arquivo também será utilizado por instrutores e monitores na correção das entregas.

O workspace em questão possui duas páginas:
  * Pagina para Debug:
    - pode ser utilizado a vontade e ter seus valores para criação, listagem, atualização ou deleção, alterados sem problemas.

  * Pagina para Testes:
    - ***NUNCA ALTERE NENHUM TESTE OU ROTA DA PÁGINA DE TESTES***;
    - para executar os testes é importante ressaltar:
      - você precisa utilizar a enviroment **test**;
      - você deve realizar ao menos uma requisição em cada uma das rotas de debug da pagina *Rotas para Testes*, antes de executar os testes.
      - ATENÇÃO: sempre REINICIE o servidor a cada novo teste ou bateria de testes, que for executar;

Regras da entrega

A entrega deve seguir as seguintes regras ou será zerada:

O código deve estar em TypeScript.
Não deve ser utilizada nenhuma outra tecnologia além das apresentadas e utilizadas nessa sprint.
A organização de arquivos deve seguir o que foi visto previamente (app.ts, interfaces.ts, logics.ts, database.ts, middlewares.ts).
Uma constante market deve ser criada em seu arquivo database.ts.
- Deverá ser um array vazio utilizado para simular o banco de dados.
Todas as funções e atributos devem ser nomeados de acordo com o solicitado.
- Caso não esteja de acordo com o estabelecido, será descontado nota.

Interfaces da aplicação

Irão existir dois tipos de produtos, Food Product e Cleaning Product. Ambos terão as mesmas informações, contando apenas com uma adição do atributo calories nos produtos do tipo food.

Para a tipagem dos produtos, deverão ser criadas 3 interfaces:

IProduct representando os dados em comum entre os dois tipo de produtos;
ICleaningProduct extendendo de IProduct;
IFoodProduct também extendendo de IProduct e contendo os dados a mais que os produtos alimentícios tem.

IProduct

Atributos

id:
- Tipo: number;
- Representa o número de identificação único do produto;
name:
- Tipo string;
- Representa o nome do produto.
price:
- Tipo: number;
- Representa o preço do produto;
- Será enviado na menor casa possível, ou seja, em centavos.
weight:
- Tipo: number;
- Representa o peso do produto;
- Será enviado na menor casa possível, ou seja, em gramas.
section:
- Tipo: "food" ou "cleaning";
- Representa a seção que o produto pertence
expirationDate:
- Tipo: Date;
- Esse atributo deverá ser gerado automáticamente, pela função de criação do produto;
- Representa a data de expiração do produto;

ICleaningProduct

Estende a interface IProduct e não acrescenta nenhum atributo a mais.

IFoodProduct

Deve estender da interface IProduct acrescentando o seguinte atributo:

Atributo

calories:
- Tipo: number;
- Representa as calorias do produto.

Endpoints da aplicação

Método	Endpoint	Responsabilidade
POST	/products	Criar e adicionar os produtos ao mercado
GET	/products	Listar todos os produtos do mercado, sendo possível listar pela section
GET	/products/:id	Listar um produto específico através do seu id
PATCH	/products/:id	Atualizar os dados de um produto através do seu id
DELETE	/products/:id	Deletar o produto a partir do seu id

Middlewares da aplicação

Verificação de nome existente

Esse middleware deverá verificar se o name enviado pelo request.body já existe no banco.
Deverá ser utilizado nas rotas:
- POST /products;
- PATCH /products/:id.
Pode ser criado um único middleware para as rotas POST e PATCH, ou podem ser criados middlewares separados, um para a rota de POST e outro para a rota de PATCH.
Caso o produto já exista deverá ser retorando um erro com status code 409 CONFLICT.

Resposta do servidor:
Formato Json
Status code: *409 CONFLICT.*

{
    "error": "Product already registered"
}

Verificação se o id buscado existe

Esse middleware deverá verificar se o id enviado por route params existe de fato no banco;
Deverá ser criado apenas um middleware e utilizado nas rotas:
- GET /products/:id;
- PATCH /products/:id;
- DELETE /products/:id.
Caso o produto não exista deverá ser um erro com status code 404 NOT FOUND.

Resposta do servidor:
Formato Json
Status code: *404 NOT FOUND.*

{
    "error": "Product not found"
}

Regras da aplicação

POST /products

Envio:

Deverá ser possível criar vários produtos de uma só vez, portanto, o envio dessa rota deve ser um array de objetos contendo todos os produtos que deverão ser cadastrados.
O id não deve ser enviado e sim criado de forma automática. Deve ser um número sequencial e não deve ser repetir.
O expirationDate não deve ser enviado e sim criado de forma automática pelo servidor. O valor deverá ser de 365 dias a partir da data de criação do produto.

Retorno:

Um objeto contendo duas chaves:
- total:
  - Tipo: number;
  - Deve ser a soma do preço de todos os produtos adicionados ao mercado;
- marketProducts:
  - Tipo: array;
  - Deve conter TODOS os produtos adiconados ao market no momento da criação.

Exemplos de envio da requisição

Corpo de envio da requisição:
Formato Json

[
    {
        "name": "Queijo",
        "price": 10,
        "weight": 30,
        "calories": 300,
        "section": "food"
    },
    {
        "name": "Presunto",
        "price": 100,
        "weight": 40,
        "calories": 1100,
        "section": "food"
    },
    {
        "name": "Detergente",
        "price": 10,
        "weight": 1000,
        "section": "cleaning"
    }
]

Resposta do servidor:
Formato Json
Status code: *201 CREATED.*

{
 "total": 120,
 "marketProducts": [
  {
   "id": 1,
   "name": "Queijo",
   "price": 10,
   "weight": 30,
   "calories": 300,
   "section": "food",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  },
  {
   "id": 2,
   "name": "Presunto",
   "price": 100,
   "weight": 40,
   "calories": 1100,
   "section": "food",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  }
  {
   "id": 3,
   "name": "Detergente",
   "price": 10,
   "weight": 1000,
   "section": "cleaning",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  }
 ]
}

GET /products

Deverá ser possível listar todos os produtos do mercado;

Retorno:

Um objeto contendo duas chaves:
- total:
  - Tipo: number;
  - Deve ser a soma do preço de todos os produtos no market;
- marketProducts:
  - Tipo: array;
  - Deve conter todos os produtos encontrados no market.

Exemplo de retorno:

O exemplo abaixo foi realizado na seguinte rota: /products.

Resposta do servidor:
Formato Json
Status code: *200 OK.*

{
 "total": 120,
 "marketProducts": [
  {
   "id": 1,
   "name": "Queijo",
   "price": 10,
   "weight": 30,
   "calories": 300,
   "section": "food",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  },
  {
   "id": 2,
   "name": "Presunto",
   "price": 100,
   "weight": 40,
   "calories": 1100,
   "section": "food",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  }
  {
   "id": 3,
   "name": "Detergente",
   "price": 10,
   "weight": 1000,
   "section": "cleaning",
   "expirationDate": "2024-03-06T12:12:32.431Z"
  }
 ]
}

GET /products/:id

Deve ser possível listar as informações de um produto com base em seu id;
O id do produto deverá ser coletado através do route param.

Exemplo de retorno:

Sucesso:

O exemplo abaixo foi realizado na seguinte rota: /products/1.

Resposta do servidor:
Formato Json
Status code: *200 OK.*

{
    "id": 1,
    "name": "Queijo",
    "price": 10,
    "weight": 30,
    "calories": 300,
    "section": "food",
    "expirationDate": "2024-03-06T12:12:32.431Z"
}

Falha:

Caso seja enviado um id inexistente no banco, não deverá ser possível listar o produto. Deverá ser retornado um objeto contendo a seguinte chave:
- error:
  - Tipo: string;
  - Deve ser uma mensagem informando que o produto não foi encontrado.

Exemplo de retorno:

O exemplo abaixo foi realizado na seguinte rota: /products/242123 informando um id inexistente.

Resposta do servidor:
Status code: *404 NOT FOUND.*

{
    "error": "Product not found"
}

PATCH /products/:id

Deve ser possível atualizar os dados de um produto de forma opcional.
Não deve ser possível atualizar os valores de id, expirationDate e section.
- Esses dados não devem ser enviados

Sucesso:

Exemplos de envio da requisição

Corpo de envio da requisição:
Formato Json

{
    "name": "Presunto defumado",
    "price": 100,
    "weight": 30,
    "calories": 300
}

Resposta do servidor:
Formato Json
Status code: *200 OK.*

{
    "id": 2,
    "name": "Presunto defumado",
    "price": 100,
    "weight": 30,
    "calories": 300,
    "section": "food",
    "expirationDate": "2024-03-06T12:12:32.431Z"
}

Falha:

Caso seja enviado um id inexistente no banco, não deverá ser possível atualizar o produto. Deverá ser retornado um objeto contendo a seguinte chave:
- error:
  - Tipo: string;
  - Deve ser uma mensagem informando que o produto não foi encontrado.

Exemplo de retorno:

O exemplo abaixo foi realizado na seguinte rota: /products/242123 informando um id inexistente.

Resposta do servidor:
Status code: *404 NOT FOUND.*

{
    "error": "Product not found"
}

DELETE /products/:id

Deve ser possível deletar um produto informando o seu id.

Sucesso:

Não deve ser retornada nenhuma mensagem, apenas o status code 204 NO CONTENT.

Exemplo de retorno:

O exemplo abaixo foi realizado na seguinte rota: /products/1.

Resposta do servidor:
Status code: *204 NO CONTENT.*

Falha:

Caso seja enviado um id inexistente no banco, não deverá ser possível deletar o produto. Deverá ser retornado um objeto contendo a seguinte chave:
- error:
  - Tipo: string;
  - Deve ser uma mensagem informando que o produto não foi encontrado.

Exemplo de retorno:

O exemplo abaixo foi realizado na seguinte rota: /products/242123 informando um id inexistente.

Resposta do servidor:
Status code: *404 NOT FOUND.*

{
    "error": "Product not found"
}

Não altere nenhum dado do readme.

repository uid: ee984c7a-2a5f-4375-baef-e8c39fece34b

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
node_modules		node_modules
src		src
.gitignore		.gitignore
README.md		README.md
market_workspace		market_workspace
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Jose-Pedro-Bernardes/api-market-express-ts

Folders and files

Latest commit

History

Repository files navigation

Mercado autônomo

Introdução

Regras da entrega

Interfaces da aplicação

IProduct

Atributos

ICleaningProduct

IFoodProduct

Atributo

Endpoints da aplicação

Middlewares da aplicação

Verificação de nome existente

Verificação se o id buscado existe

Regras da aplicação

POST /products

Envio:

Retorno:

Exemplos de envio da requisição

GET /products

Retorno:

Exemplo de retorno:

GET /products/:id

Exemplo de retorno:

Sucesso:

Falha:

Exemplo de retorno:

PATCH /products/:id

Sucesso:

Exemplos de envio da requisição

Falha:

Exemplo de retorno:

DELETE /products/:id

Sucesso:

Exemplo de retorno:

Falha:

Exemplo de retorno:

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages