fastapi-realworld-api

Exemplo de projeto com FastAPI e SQLModel usando async/await utilizado no mundo real.
Meu desejo é apresentar um motor de API REST utilizando o que considero que tem de melhor no universo Python. [MINHA OPINIÃO]

Requerimentos

• Python ~3.12
• Poetry ~1.8.0

Como usar

Segue abaixo os passos para iniciar a aplicação.

Passos 1, 2 e 3 precisam ser executados somente na primeira vez.

1. Instalar dependencias

Na primeira vez é necessario instalar todas as dependencias executando o seguinte comando:

poetry install

2. Criar arquivo .env

Criar o arquivo .env na raiz do projeto com:

db_url=sqlite+aiosqlite:///database.db
db_debug=1
token_secret_key=09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7

3. Executar migrações

Preparar o banco de dados para o uso:

poetry run migrate

4. Iniciar aplicação

Iniciar a aplicação (modo watch):

poetry run server

Após iniciado, o OpenAPI Specification da aplicação estará disponivel em 2 endpoints:

• http://localhost:5000/docs
• http://localhost:5000/redoc

Changelog

Todas as notas de alteração deste projeto serão documentados no CHANGELOG.md.