mario-lacerda/proj-fastapi

curso: Python AI Backend Developer desafio: Desenvolvendo sua Primeira API com FastAPI, Python e Docker

Python AI Backend Developer

💻 Desafio de projeto:

Desenvolvendo sua Primeira API com FastAPI, Python e Docker

Entendendo o Desafio

Agora é a sua hora de brilhar e construir um perfil de destaque na DIO! Explore todos os conceitos explorados até aqui e replique (ou melhore, porque não?) este projeto prático. Para isso, crie seu próprio repositório e aumente ainda mais seu portfólio de projetos no GitHub, o qual pode fazer toda diferença em suas entrevistas técnicas 😎

Neste repositório, insira todos os links e arquivos necessários para seu projeto, seja um arquivo de banco de dados ou um link para o template no Figma.

Dica: Se o expert forneceu um repositório Github, você pode dar um "fork" no repositório dele para organizar suas alterações e evoluções mantendo uma referência direta ao código-fonte original.

Repositório Git

O Git é um conceito essencial no mercado de trabalho atualmente, por isso sempre reforçamos sua importância em nossa metodologia educacional. Por isso, todo código-fonte desenvolvido durante este conteúdo foi versionado no seguinte endereço para que você possa consultá-lo a qualquer momento:

https://github.com/digitalinnovationone/workout_api

Instruções:

• adicionar query parameters nos endpoints

  - atleta
        - nome
        - cpf
  

• customizar response de retorno de endpoints

  - get all
        - atleta
              - nome
              - centro_treinamento
              - categoria
  

• Manipular exceção de integridade dos dados em cada módulo/tabela

  - sqlalchemy.exc.IntegrityError e devolver a seguinte mensagem: “Já existe um atleta cadastrado com o cpf: x”
  - status_code: 303
  

• Adicionar paginação utilizando a lib: fastapi-pagination

  - limit e offset
  

⚡ Tecnologias Utilizadas

• pipenv - controle de versão
• PostgreSQL - banco de dados com docker-compose
• SQLAlchemy + Pydantic + Alembic - conexão com banco de dados
• FastAPI - desenvolver a aplicação

💡 Solução do desafio

O código foi feita seguindo a aula da instrutora.

Para executar o código:

• Rodar banco de dados na pasta workout_api

$ docker-compose up -d

• Rodar alembic na pasta do projeto (local do Makefile)

$ make run-migrations

• Rodar app na pasta do projeto

$ make run

Adicionar query parameters nos endpoints

  - atleta
        - nome
        - cpf

Foi adicionado no arquivo atleta/controller.py. É necessário fornecer nome e cpf para a consulta.

@router.get(
        path='/nome={nome}', 
        summary='consultar um atleta pelo nome',
        status_code = status.HTTP_200_OK,
        response_model= AtletaOut,
        ) 


async def query(nome: str, db_session: DatabaseDependency, cpf: str | None = None) -> AtletaOut:
    atleta: AtletaOut = (
    await db_session.execute(select(AtletaModel).filter_by(nome=nome, cpf=cpf))
        ).scalars().first()
     
    if not atleta:
        raise HTTPException(
            status_code = status.HTTP_404_NOT_FOUND, 
            detail= f'Atleta não encontrado com nome: {nome}'
            )
    
    return atleta

Customizar response de retorno de endpoints

  - get all
        - atleta
              - nome
              - centro_treinamento
              - categoria

Foi criado o schema personalizado em atletas/schemas.py

class AtletaResponse(BaseSchema):
    nome: Annotated[str, Field(description='Nome do Atleta', example='Joao', max_length=50)]
    categoria: Annotated[CategoriaIn, Field(description='Categoria do Atleta')]
    centro_treinamento: Annotated[CentroTreinamentoAtleta, Field(description='Centro de treinamento do Atleta')]

Foi adicionado o endpoint no arquivo atleta/controller.py.

@router.get(
        path='/all_atletas', 
        summary='consulta personalizada todos os atletas',
        status_code = status.HTTP_200_OK,
        response_model= list[AtletaResponse],
        ) 


async def query(db_session: DatabaseDependency) -> list[AtletaResponse]:
    atletas: list[AtletaResponse] = (await db_session.execute(select(AtletaModel))).scalars().all()

    return [AtletaResponse.model_validate(atleta) for atleta in atletas]

Manipular exceção de integridade dos dados em cada módulo/tabela

  - sqlalchemy.exc.IntegrityError e devolver a seguinte mensagem: “Já existe um atleta cadastrado com o cpf: x”
  - status_code: 303

No arquivo atleta/controller.py foi necessário importar:

from sqlalchemy.exc import IntegrityError

E adicionada a exceção após o try commit.

    await db_session.commit()
    except IntegrityError:
        raise HTTPException(
            status_code=status.HTTP_303_SEE_OTHER,
            detail=f'Já existe um atleta cadastrado com o cpf: {atleta_in.cpf}'
        )

Analogamente para o controller.py de categorias e centro_treinamento, mas ao invés do CPF o usei o Nome que é a variável única nesse caso.

Adicionar paginação utilizando a lib: fastapi-pagination

  - limit e offset

No arquivo main.py adicionei o import:

from fastapi_pagination import add_pagination

E ao final do arquivo adicionei:

add_pagination(app)

Adicionei paginação para a consulta de todos os atletas modificando no arquivo atleta/controller.py

Import:

#Add pagination with SQLAlchemy
from fastapi_pagination import LimitOffsetPage, Page
from fastapi_pagination.ext.sqlalchemy import paginate

Endpoint:

@router.get(
        path='/', 
        summary='consultar todos os atletas',
        status_code = status.HTTP_200_OK,
        response_model= LimitOffsetPage[AtletaOut],
        ) 


async def query(db_session: DatabaseDependency):
    
    return await paginate(db_session, select(AtletaModel))

Todos os endpoints estão funcionando como esperado.