API de Basquete NBA

Esta é uma API REST desenvolvida com FastAPI para fornecer informações sobre jogadores e times da NBA.

Requisitos

• Python 3.x
• PostgreSQL
• Dependências listadas em requirements.txt

Configuração do Ambiente

1. Clone o repositório
2. Instale as dependências:

pip install -r requirements.txt

3. Configure as variáveis de ambiente necessárias:

POSTGRES_HOST=seu_host
POSTGRES_DB=seu_banco
POSTGRES_USER=seu_usuario
POSTGRES_PASSWORD=sua_senha
POSTGRES_PORT=sua_porta

Executando a API

Para iniciar a API, execute:

python src/app_api.py

A API estará disponível em http://localhost:8500

Endpoints da API

1. Verificação de Status

• URL: /
• Método: GET
• Descrição: Endpoint de verificação de status da API
• Resposta de Sucesso:

  {
    "status": "API is running"
  }

2. Buscar Jogador

• URL: /players/{player_id}
• Método: GET
• Parâmetros:
  • player_id (path parameter): ID do jogador
• Descrição: Retorna informações de um jogador específico
• Resposta de Sucesso: Dados do jogador em formato JSON

3. Buscar Time

• URL: /teams/{team_id}
• Método: GET
• Parâmetros:
  • team_id (path parameter): ID do time
• Descrição: Retorna informações de todos os jogadores de um time específico
• Resposta de Sucesso: Lista de jogadores do time em formato JSON

Estrutura do Banco de Dados

A API utiliza uma tabela PostgreSQL chamada players_nba que contém informações sobre os jogadores da NBA.

Tecnologias Utilizadas

• FastAPI
• PostgreSQL
• psycopg2
• uvicorn

Contribuição

Para contribuir com o projeto:

1. Faça um fork do repositório
2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
3. Commit suas mudanças (git commit -m 'Adiciona nova feature')
4. Push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request