Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 4.71 KB

README.md

File metadata and controls

83 lines (52 loc) · 4.71 KB
Raw

API de Alta Escalabilidade com FastAPI, PostgreSQL, Redis e RabbitMQ

A aplicação em questão é uma prova de conceito (PoC) que visa testar a escalabilidade de uma API construída com o uso do framework FastAPI, bem como a integração de tecnologias como PostgreSQL, Redis, RabbitMQ e Celery. A principal finalidade dessa PoC é analisar o desempenho do conjunto de tecnologias em cenários de alta carga de requisições. Vale destacar que esse projeto não está pronto para ser implantado em ambientes de produção, sendo destinado apenas a testes e avaliações.

Objetivo da Prova de Conceito

O foco principal desta PoC não é entregar uma solução completa para produção, mas sim estabelecer um ambiente controlado para simular e avaliar o comportamento das tecnologias selecionadas sob uma carga considerável de requisições. A PoC possibilita a análise da escalabilidade, eficiência e desempenho do ecossistema adotado, permitindo a obtenção de insights valiosos para futuras implementações.

Tecnologias Utilizadas

  • FastAPI: Um framework moderno e de alto desempenho para a construção de APIs em Python.
  • PostgreSQL: Um sistema de gerenciamento de banco de dados relacional para armazenar informações de pessoas.
  • Redis: Um sistema de cache em memória, utilizado para otimizar o acesso a dados frequentemente consultados.
  • RabbitMQ: Um sistema de mensagens que possibilita a execução de tarefas assíncronas em segundo plano.
  • Celery: Uma biblioteca que trabalha em conjunto com um message broker para facilitar o agendamento e a execução de tarefas assíncronas.
  • Docker Compose: Uma ferramenta para orquestrar múltiplos contêineres e criar um ambiente de desenvolvimento consistente.

Rotas Implementadas

GET /pessoas/{pessoa_id}

Esta rota permite recuperar informações detalhadas sobre uma pessoa específica com base no ID fornecido. Ela aproveita o cache Redis para otimizar o acesso aos dados e, caso necessário, recupera informações do banco de dados PostgreSQL. Isso garante uma resposta rápida e eficiente para a consulta.

GET /pessoas?t=

Esta rota permite realizar pesquisas por pessoas com base em um termo de busca fornecido como parâmetro de consulta.

GET /contagem-pessoas

Esta rota retorna o número total de pessoas armazenadas no banco de dados PostgreSQL.

POST /pessoas

Esta rota permite criar uma nova entrada de pessoa no banco de dados. Ela realiza as seguintes etapas:

  • Valida se o apelido da pessoa já está em uso usando o sistema de cache.

  • Gera um ID único para a pessoa.

  • Armazena a pessoa no banco de dados PostgreSQL.

  • Inicia uma tarefa assíncrona para inserir a pessoa no banco de dados usando Celery.

    Dados do Schema e Validações:

    Ao enviar uma requisição POST para esta rota, você deve fornecer os dados do usuário no corpo da requisição. Os dados do usuário são validados de acordo com o seguinte schema:

    class PessoaSchema(BaseModel):
    apelido: str
    nome: str
    nascimento: str
    stack: Optional[List[str]] = None

    Os seguintes validadores são aplicados:

    • apelido: Deve ser uma string única que identifica o apelido da pessoa.
    • nome: Nome da pessoa.
    • nascimento: Data de nascimento da pessoa no formato AAAA-MM-DD.
    • stack: Lista opcional de strings, onde cada item deve ter no máximo 32 caracteres.

    Além disso, os campos nome, apelido e nascimento não podem ser nulos e devem ser strings válidas.

Execução da PoC

Siga estas etapas para executar a prova de conceito:

  1. Clone este repositório para o seu sistema local.

  2. Certifique-se de ter o Docker Compose instalado em seu ambiente.

  3. Navegue até o diretório do projeto no terminal.

  4. Execute o seguinte comando para iniciar os serviços definidos no arquivo docker-compose.yml:

    docker-compose up -d

  5. Aguarde até que todos os contêineres estejam em execução.

  6. Acesse a documentação interativa da API em seu navegador, utilizando o URL http://localhost:9999/docs.

Considerações Finais

Esta PoC oferece um vislumbre de como construir uma API robusta e escalável utilizando tecnologias modernas e práticas de desenvolvimento. Ela destaca a importância de utilizar cache para otimização de consultas, tarefas assíncronas para melhorar a performance geral da aplicação e validações sólidas para garantir a integridade dos dados recebidos. Este projeto pode servir como ponto de partida para a construção de aplicações maiores e mais complexas que exigem alta escalabilidade. Certifique-se de personalizar as configurações conforme necessário e explorar ainda mais as funcionalidades avançadas das tecnologias empregadas.