FastAPI Microservice Helper
Project description
FastAPI Request helper
How to use
- Set a variable
# user_service.py
from fastapi import FastAPI
from fastapi_global_variable import GlobalVariable
app = FastAPI(title="Application")
GlobalVariable.set('app', app)
- Use variable
from fastapi_global_variable import GlobalVariable
print(GlobalVariable.get_or_fail('app'))
print(GlobalVariable.get('app'))
- Decorators
FastAPI Request Helper provides lots of helpful decorators:
- Swagger docs decorators: @controller, @tag, @get, @post, @put, @delete, @patch
- Rate limit request: @rate_limit
- FastAPI response model: @response
- FastAPI guards: @guard, @gurads
- FastAPI response status: @status
- FastAPI API info details: @description, @summary, @name
- FastAPI API response status: @status_no_content, @status_ok, @status_created
- Hide API: @hidden_when(condition: boolean)
Fast API Helper also provides Pagination Query params helper: PaginationParams
# Sample
from fastapi_request_helper import (
controller,
post,
rate_limit,
response,
status_created,
status_no_content,
status_ok,
tag,
)
@controller('authentications')
@tag('Authentication')
class AuthenticationController:
def __init__(self, auth_service: AuthenticationService = Depends()):
self.auth_service = auth_service
@post('create-email-otp')
@status_no_content()
async def create_email_otp(self):
pass
How to test in testpypi
- Increase the version in
pyproject.toml
- Run command
$ ./build_and_test.sh
How to publish new version
- Increase the version in
pyproject.toml
- Run command
$ ./build_and_publish.sh
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for fastapi_microservice_helper-0.0.21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8b098d8daf6eeaad157ef9fcf61e2409dfff77c1e1bf2402cd55c3d16710e16 |
|
MD5 | dd9503ca896b00c986eca54595e91b24 |
|
BLAKE2b-256 | 7263ea2dcd7871a804f297f78f2ad394adf28b3a84b351c9dc0dc26dec4c0913 |
Close
Hashes for fastapi_microservice_helper-0.0.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54c0b6dd24fbd00173193b0266c014dc1e3d1409e622f8a17c43dffb82f6fb78 |
|
MD5 | f83b5308bddbfd11965d06d618e06e4d |
|
BLAKE2b-256 | 940e8827fe8f5e9049f4800e63e7ffee32948b650b50095bb69bcb9a7e2ead92 |