mdccg / dynamic-store-api

API de uma loja fictícia com documentação via Swagger.

dynamic-store-api

Sumário

• dynamic-store-api
  • Sumário
  • Motivação
  • Pilha de tecnologia
  • Como rodar
    • Pré-requisitos
    • Passo a passo

Motivação

Este app consiste em uma API que simula o funcionamento de uma loja fictícia. O destaque desta atividade em comparação com a atividade anterior é que o desenvolvimento ocorreu de maneira quase independente, sem recursos pré-existentes apelativos por parte do professor ou de soluções prontas. O resultado é uma aplicação que reflete não apenas a funcionalidade de uma loja virtual, com seus produtos, descrições, preços e quantidades, mas também a dedicação e esforço necessários para criar uma documentação intuitiva e interativa.

Este foi o quarto repositório de código apresentado no Curso Superior de TSI do IFMS como requisito para obtenção da nota parcial das atividades da unidade curricular Web Services.

← Repositório anterior	Próximo repositório →

Pilha de tecnologia

Papel	Tecnologia
Linguagem de programação	TypeScript
Framework back-end	Express.js
Banco de dados	SQLite
Mapeamento Objeto-Relacional	TypeORM
API de documentação dinâmica	Swagger

Como rodar

Pré-requisitos

• Node;
• Yarn (opcional).

Passo a passo

1. Clone o repositório de código em sua máquina;

2. Abra um shell de comando de sua preferência (prompt de comando, PowerShell, terminal etc.);

3. Instale as dependências do projeto através do seguinte comando:

$ npm install

Caso esteja utilizando o gerenciador de pacotes Yarn, execute o seguinte comando como alternativa:

$ yarn

4. Execute o seguinte comando para executar o app:

Para npm:

$ npm run start

Para Yarn:

$ yarn start

5. Acesse o endereço de URL http://localhost:3001/docs para conferir a documentação da API gerada pelo Swagger a partir dos arquivos YAML.