HEROES API 💻

Technologies • Getting Started • API Endpoints • Collaborators • Contribute

Projeto usado como uma api para criar deletar e alterar personagens em um banco de dados não oficial de personagens da DC

💻 Technologies

• Javascript
• MongoDB
• NodeJS
• Express
• Ajv

🚀 Getting started

Here you describe how to run your project locally

Prerequisites

Here you list all prerequisites necessary for running your project. For example:

• NodeJS
• Mongodb

Cloning

How to clone your project

git clone your-project-url-in-github

Starting

How to start your project

cd project-name
npm install
npm start

Certifique-se de que o MongoDB esteja em execução

mongod

📍 API Endpoints

Here you can list the main routes of your API, and what are their expected request bodies. ​

route	description
GET /personagens	Retorna todos os Herois cadastrados response details
GET /personagens/nickname	Retorna apenas o heroi com o nickname especificado response details
POST /personagens/	Adiciona atraves do corpo da requisição as informações do personagem response details
PATCH /personagens/nickaname	Atualiza atraves do corpo da requisição as informações do personagem response details
DELETE /personagens/nickname	Remove atarvés do nickname o personagem no banco de dados response details

GET /personagens

RESPONSE

[
  {
    "realname": "Bruce Wayne",
    "nickname": "Batman",
    "description": "Bilionário e filantropo de Gotham City, que combate o crime usando suas habilidades em artes marciais e tecnologia avançada, além de sua inteligência."
  }
]

POST /personagens

REQUEST

{
  "realname": "Bruce Wayne",
  "nickname": "Batman",
  "description": "Bilionário e filantropo de Gotham City, que combate o crime usando suas habilidades em artes marciais e tecnologia avançada, além de sua inteligência."
}

GET /personagens/Batman

RESPONSE

{
    "realname": "Bruce Wayne",
    "nickname": "Batman",
    "description": "Bilionário e filantropo de Gotham City, que combate o crime usando suas habilidades em artes marciais e tecnologia avançada, além de sua inteligência."
}

PATCH /personagens/Batman

REQUEST

{
  "realname": "Bruce Wayne",
  "nickname": "Batman",
  "description": "Bilionário e filantropo de Gotham City, que combate o crime usando suas habilidades em artes marciais e tecnologia avançada, além de sua inteligência."
}

RESPONSE

{
    "message": "Personagem atualizado com sucesso"
}

DELETE /personagens/Batman

RESPONSE

{
    "message": "Personagem removido com sucesso"
}

🤝 Collaborators

João Marcos Silva

📫 Contribute

Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request

1. git clone https://github.com/Joaosilvateixeira33/text-editor.git
2. git checkout -b feature/NAME
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern