Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leynier/fastapi-control
FastAPI utility to implement class-based routing with controllers and dependency injection.
https://github.com/leynier/fastapi-control
dependency-injection fastapi fastapi-controllers fastapi-extension kink mit-license opensource python
Last synced: 2 months ago
JSON representation
FastAPI utility to implement class-based routing with controllers and dependency injection.
- Host: GitHub
- URL: https://github.com/leynier/fastapi-control
- Owner: leynier
- License: mit
- Created: 2022-04-29T06:04:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T00:32:45.000Z (6 months ago)
- Last Synced: 2024-10-11T01:50:18.340Z (3 months ago)
- Topics: dependency-injection, fastapi, fastapi-controllers, fastapi-extension, kink, mit-license, opensource, python
- Language: Python
- Homepage: https://pypi.org/project/fastapi-control
- Size: 274 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Welcome to FastAPI Control 👋
[](https://opensource.org/licenses/MIT)
[](https://www.python.org/)
[](https://pypi.python.org/pypi/fastapi-control)
[](https://pypi.python.org/pypi/fastapi-control)
[](https://github.com/leynier/fastapi-control/commits)
[](https://github.com/leynier/fastapi-control/commits)
[](https://github.com/leynier/fastapi-control/stargazers)
[](https://github.com/leynier/fastapi-control/network/members)
[](https://github.com/leynier/fastapi-control)
[](https://github.com/leynier/fastapi-control/graphs/contributors)
FastAPI utility to implement class-based routing with controllers and dependency injection.
## Install
```sh
pip install fastapi-control
```
## Usage
```python
from fastapi import FastAPI
from fastapi_control import (
APIController,
add_controller,
add_controllers,
controller,
get,
inject,
)
# Optionally declares an abstraction
class GreeterAbstraction:
def greet(self):
raise NotImplementedError()
# Implement the abstraction and make it available to the injection system
# using the @inject decorator
@inject(alias=GreeterAbstraction)
class GretterImplementation:
def greet(self):
return "Hello, world!"
# It is also possible to implement without abstraction and make it available
# to the injection system directly
@inject()
class SpanishGretterImplementation:
def greet(self):
return "Hola, mundo!"
@inject()
class NestedGretterImplementation:
# When the @inject decorator is used, the arguments of the __init__
# method are automatically injected (if the @inject decorator was used
# in the argument type declarations)
def __init__(self, spanish_gretter: SpanishGretterImplementation) -> None:
self.gretter = spanish_gretter
def greet(self):
return self.gretter.greet()
# With the @controller decorator and inheriting from APIController, we can
# declare class-based routing (also called controller) and it has the same
# parameters as FastAPI's APIRouter
@controller(prefix="/home")
class HomeController(APIController):
# When the @controller decorator is used, the arguments of the __init__
# method are automatically injected (if the @inject decorator was used
# in the argument type declarations)
def __init__(
self,
gretter: GreeterAbstraction,
spanish_gretter: SpanishGretterImplementation,
nested_gretter: NestedGretterImplementation,
) -> None:
self.gretter = gretter
self.spanish_gretter = spanish_gretter
self.nested_gretter = nested_gretter
# The @get decorator declares the method as a GET endpoint (there are
# also @post, @put, @delete, @patch decorators) and the behavior is the
# same as the corresponding FastAPI decorators.
@get(path="/greet")
def get_greet(self):
return self.gretter.greet()
@get(path="/spanish_greet")
def get_spanish_greet(self):
return self.spanish_gretter.greet()
@get(path="/nested_greet")
def get_nested_greet(self):
return self.nested_gretter.greet()
api = FastAPI()
# Finally, it is necessary to add the controllers to the FastAPI instance
add_controllers(api)
# If you want to have multiple FastAPI instances with different controllers,
# you can use the add_controller method to add the desired controllers to
# the desired FastAPI instance one by one.
other_api = FastAPI()
add_controller(other_api, HomeController)
```
## Inspirations
This project is based on and inspired by the [NEXTX](https://github.com/adriangs1996/nextx.repository) and [FastApi-RESTful](https://github.com/yuval9313/FastApi-RESTful) projects.
The difference with [FastApi-RESTful](https://github.com/yuval9313/FastApi-RESTful) is that **FastAPI Control** implements an automatic dependency injection system independent of [FastAPI](https://fastapi.tiangolo.com).
The difference with [NEXTX](https://github.com/adriangs1996/nextx.repository) is that **FastAPI Control** only aims to solve the problem of class-based routes and automatic dependency injection, and uses the [kink](https://github.com/kodemore/kink) library for dependency injection which is still under maintenance while [NEXTX](https://github.com/adriangs1996/nextx.repository) uses [python-inject](https://github.com/ivankorobkov/python-inject) which has not been maintained since 2020.
Many thanks to the creators and maintainers of those projects for providing inspiration and guidance for this one.
## Authors
👨🏻💻 **Leynier Gutiérrez González**
* Website: [leynier.dev](https://leynier.dev)
* LinkedIn: [@leynier](https://linkedin.com/in/leynier)
* Github: [@leynier](https://github.com/leynier)
* Twitter: [@leynier41](https://twitter.com/leynier41)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/leynier/fastapi-control/issues). You can also take a look at the [contributing guide](CONTRIBUTING.md).
## Show your support
Give a ⭐️ if this project helped you!