Esta API permite aos usuários criar e gerenciar times de Pokémon. Utilizando a PokeAPI para buscar informações detalhadas sobre cada Pokémon, os usuários podem registrar times, listar todos os times existentes, e buscar times por usuário. Esta documentação fornece todas as informações necessárias para começar a usar a API, incluindo detalhes sobre os endpoints disponíveis, exemplos de uso e instruções para rodar a aplicação em um container Docker.
Para utilizar esta API, você precisa ter Python e Flask instalados em seu ambiente. Siga os passos abaixo para configurar seu ambiente:
- Certifique-se de ter o Python 3.8 ou superior instalado em seu sistema.
- Use o pip para instalar Flask e Requests. (pip install Flask requests)
- Clone o código fonte da API do repositório Git para seu ambiente local.
- Listar Todos os Times
- Método: GET
- Endpoint: /api/teams
- Descrição: Retorna uma lista de todos os times registrados.
- Buscar Time por Usuário
- Método: GET
- Endpoint: /api/teams/{user}
- Descrição: Busca um time registrado pelo nome do usuário.
- Criar um Novo Time
- Método: POST
- Endpoint: /api/teams
- Descrição: Registra um novo time com base em uma lista de Pokémons fornecida.
- Corpo da Requisição:(JSON)
{
"user": "nome_do_usuario",
"team": ["pokemon1", "pokemon2", "pokemon3", "pokemon4", "pokemon5", "pokemon6"]
}
A API usa códigos de status HTTP padrão para indicar o sucesso ou falha de uma requisição. Por exemplo, um código 404 é retornado quando um Pokémon específico não é encontrado, e um código 400 é retornado quando a requisição está malformada ou faltando dados necessários.
- Buscando time por usuário:
- "Team not found": Usuario procurado não cadastrado.
- Criando Times:
- "User and team are required": Necessário repassar um usuário e um time de pokemons, caso contrário esse erro é retornado.
- "Pokemon {name} not found": O pokemon não existe ou seu nome está escrito de forma incorreta.
Utilizando o terminal no diretório criado:
Execute o comando: docker-compose up --build