/pokemon

Primary LanguageTypeScript

👾 Pokemon API

Develop by

Sobre · Tecnologias utilizadas · Como usar · Material de apoio

💭 Sobre

Uma pequena API com um CRUD de pokemons e com um endpoint para uma batalha entre dois pokemons.

👨‍💻 Tecnologias Utilizadas

⁉ Como usar

🤔 Pré-requisitos

Para conseguir utilizar a aplicação sem nenhum problema é necessário ter em sua máquina:

  • Ter em sua máquina o NPM ou Yarn para o gerenciamento dos pacotes da aplicação.
  • Ter o Docker para facilitar o setup do banco de dados.
  • E não menos importante, o Git para clonar o repositório em seu computador.

📝 Passo a passo

Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:

  1. Clonando o repositório
  # Clone o repositório
  $ git clone https://github.com/Gabrielpatrola/pokemon.git
  # Entre na pasta raiz da aplicação
  $ cd pokemon
  1. Instalar as dependências da aplicação
  $ yarn # ou npm install
  1. Configurar as variáveis de ambiente

Crie um arquivo chamado de '.env' copiando as informações existentes no arquivo '.env.example'.

  1. Iniciar docker da aplicação, este ja iniciará o postgresql
  # Comando para iniciar a aplicação em modo de desenvolvimento
  $ docker-compose up -d
  1. Inicie a aplicação
  $ yarn dev # ou npm run dev
  1. Testando a aplicação
  # Comando para realizar os testes
  $ yarn test # ou npm run test

📚 Material de apoio

Este projeto inclui uma documentação interativa da API utilizando o Swagger UI, que oferece uma maneira fácil e visual de explorar todos os endpoints disponíveis, bem como realizar chamadas de teste diretamente pelo navegador.

Usando o Swagger UI

  1. Inicie a Aplicação: Certifique-se de que a aplicação esteja rodando localmente em sua máquina ou esteja acessível em um ambiente de desenvolvimento remoto, conforme as instruções fornecidas na seção "Como Usar" deste documento.

  2. Acesse o Swagger UI: entre em http://localhost:3333/api-docs.

  3. Explore a Documentação: Uma vez no Swagger UI, você poderá ver uma lista de todos os endpoints disponíveis, modelos de dados, e realizar chamadas de teste para a API. Cada endpoint listado terá informações detalhadas sobre os métodos HTTP suportados, parâmetros esperados, e os formatos de resposta.

  4. Teste a API: Para testar um endpoint específico, clique no método desejado para expandir os detalhes. Você poderá fornecer valores para os parâmetros requeridos e então clicar no botão "Try it out!" para fazer uma chamada de teste.

Online

Caso queira testar online sem ter que clonar o repositório, entre no link:Pokemon API