https://github.com/aavache/fastapi-designs

FastAPI design patterns and building blocks to build an API
https://github.com/aavache/fastapi-designs

api fastapi patterns python restful-api tutorial web

Last synced: 29 days ago
JSON representation

FastAPI design patterns and building blocks to build an API

• Host: GitHub
• URL: https://github.com/aavache/fastapi-designs
• Owner: Aavache
• Created: 2023-08-12T04:47:09.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-13T07:00:54.000Z (over 1 year ago)
• Last Synced: 2024-11-10T16:46:22.571Z (3 months ago)
• Topics: api, fastapi, patterns, python, restful-api, tutorial, web
• Language: Python
• Homepage:
• Size: 37.1 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
FastAPI Designs


This repository contains practical examples demonstrating various concepts and best practices for building powerful APIs using FastAPI. Each example showcases a specific aspect of API development and code samples to help you understand and implement these concepts effectively.

## Installation

Install your dependencies with the following command:

```sh

pip install -r requirements.txt

```

## Available Content

1. [Building blocks](https://github.com/Aavache/fastapi-designs/tree/master/00_building_blocks)

    1. [Pagination](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/00_pagination.py)

    2. [Error handling](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/01_error_handling.py)

    3. [URL Versioning](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/02_url_versioning.py) 

    4. [Header Versioning](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/03_header_versioning.py)

    5. [Caching](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/04_caching.py)

    6. [Deprecation](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/05_deprecation.py)

    7. [Decorator](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/06_decorator.py)

    8. [Decorator for auth](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/06_decorator_auth.py)

    9. [Rate limitter](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/07_rate_limitters.py)

    10. [Filtering and sorting](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/08_filtering_and_sorting.py)

    11. [Bulk operations](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/09_bulk_operations.py)

    12. [Authentification](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/10_authentication.py)

    13. [WebHooks](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/11_webhooks.py)

    14. [Async Polling](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/12_async_polling.py)

    15. [Async Callback](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/13_async_callback.py)

    16. [HATEOAS](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/14_hateoas.py)

    17. [Singleton](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/15_singleton.py)

    18. [Content negotiation](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/16_content_negotiation.py)

    19. [Strategy pattern](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/17_strategy_pattern.py)

    20. [Repository pattern](https://github.com/Aavache/fastapi-designs/blob/master/00_building_blocks/18_repository_pattern.py)

2. [APIs](https://github.com/Aavache/fastapi-designs/tree/master/01_apis)

    1. [RESTful](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/00_restful.py)

    2. [Message Queue](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/01_mesage_queue.py)

    3. [RPC](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/02_rpc.py)

    4. [Event driven](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/03_event_driven.py)

    5. [Hypermedia](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/04_hypermedia.py)

    6. [SOAP](https://github.com/Aavache/fastapi-designs/blob/master/01_apis/05_soap.py)

## Disclaimer

This repository shows some API patterns and building blocks in a simplified manner, therefore it can serve as inspiration for real-case applications however it is likely to require extra adaption, for instance, we use an in-memory dictionary to simulate a database for some cases.

## References

The scripts in this repository are based on the following documentation:

1. [FastAPI](https://fastapi.tiangolo.com/) documentation.

2. [Pika](https://pika.readthedocs.io/en/stable/) documentation.