/heroesapi

API heroes em desenvolvimento com Node, MongoDB, Docker e docker-composer.

Primary LanguageJavaScript

API Heroes

O projeto se trata de uma api para registro de heróis e seus poderes com CRUD completo para interações.

Instalação

clonar o repositório, abrir o projeto e executar o comando:

  npm install
  npm start

ou

  npm i
  npm start
  • Necessário instalar o MongoDB na máquina.
Print - Configurações de testes

Print teste Postman

API Reference

Parte I

Get all heroes

  GET /heroes/

Get hero

  GET /heroes/:id

Post hero

  POST /heroes/

Put hero

  PUT /heroes/:id

Delete hero

  GET /heroes/:id
Parameter Type Description
name String Required
description String Text: true
rank Number Required
active Boolean default: true
Parte II

Get all powerstats

  GET /heroes/:id/powerstats/

Get powerstats

  GET /heroes/:id/powerstats/:id

Post powerstats

  POST /heroes/:id/powerstats/

Put powerstats

  PUT /heroes/:id/powerstats/:id

Delete powerstats

  GET /heroes/:id/powerstats/:id
Parameter Type Description
heroId Heroes(id) Reference
name String Required
value Number valitate: Number.isInteger

Techs Usadas

Node, MongoDB, Docker, Docker-Composer, Bootstrap CDN

Ferramentas

Postman, VSCode, MongoDB Compass, Docker

Dependências

"dependencies": {
    "cors": "^2.8.5",
    "ejs": "^3.1.6",
    "express": "^4.17.1",
    "mongoose": "^5.13.3",
    "mongoose-auto-increment": "^5.0.1",
    "morgan": "^1.10.0"
  },
  "devDependencies": {
    "nodemon": "^2.0.12"
}

Authors