rannysweis / fast-api-docker-poetry

Fast Api / Docker / Poetry

Contents

1. Requirments
2. Best Practices
3. File structure
4. Quick Start

Requirments

• docker
• docker compose
• poetry

Best Practices

1. Naming conventions
   1. Every file should have a unique name
   2. Add type to file name outside of models. I believe it helps with search-ability/readability

      order_controller, order_service, order_repository
      

2. Set custom exception_handler in main.py to better format error responses

      application.add_exception_handler(HTTPException, exh.http_exception_handler)
   

3. Use @cbv decorator to initialize shared dependencies.

      @cbv(order_router)
      class OrderController:
          def __init__(self):
              self.order_service = OrderService()
   

4. Model files has ORM and pydantic classes for easier updates (Might not be the best solution for all)
   • Schema - request/response object. It uses BaseSchema.to_orm to convert to ORM
   • ORM - DB object
5. Here is the commit before switching to async

File structure

fast-api-docker-poetry 
├── app
│   ├── config                                --  app configs
│   │   ├── exception_handlers.py        
│   │   ├── settings.py                  
│   ├── controllers                           --  api routes by objects
│   │   ├── order_controller.py 
│   └── models                                --  orm and pydantic models
│   │   ├── order.py
│   │   ├── address.py
│   │   ├── base.py
│   │   ├── pageable.py
│   └── repository                            --  database queries
│   │   ├── order_repository.py
│   └── services                              --  business logic / data transformation
│   │   ├── order_service.py
│   └── utils
│   │   ├── db.py
│   └── main.py
├── migrations/                               --  alembic migrations
├── tests/
│   ├── integrations                          --  test api routes by using TestClient
├── .env
├── .gitignore
├── docker-compose.yml
├── Makefile
├── pyproject.toml
└── alembic.ini

Quick Start

1. Start with jaeger tracing using docker

   make startd
   

2. Start with no tracing using docker

   make startslimd
   

3. Test with docker

   make testd
   

4. Start with poetry

   make startp
   

5. Test with poetry

   make testp