backbone-api
OpenAPI request and response models
Installation & Upgrade
pip install basalam.backbone-api
TODO List
- Add Message Toast Field
- Add Pagination Query Params Dependency
Usage Example
import uvicorn
from fastapi import APIRouter
from fastapi import FastAPI
from pydantic import BaseModel
from basalam.backbone_api.responses import (
ForbiddenResponse,
NotFoundResponse,
UnauthorizedResponse,
UnprocessableContentResponse,
BulkResponse, ConflictResponse
)
app = FastAPI()
class User(BaseModel):
id: int
name: str
router = APIRouter(responses={
401: {"model": UnauthorizedResponse},
403: {"model": ForbiddenResponse},
404: {"model": NotFoundResponse},
409: {"model": ConflictResponse},
422: {"model": UnprocessableContentResponse}
})
@router.get("/", response_model=BulkResponse[User])
async def root():
ls = [
User(id=1, name="John Doe"),
User(id=2, name="Jane Boe")
]
return BulkResponse(data=ls).as_json_response()
app.include_router(router)
if __name__=="__main__":
uvicorn.run(app, host="localhost", port=8000)
Using Exceptions
in app.py
from fastapi import FastAPI
from basalam.backbone_api.exceptions.client_error.handlers import client_error_exception_handler
from basalam.backbone_api.exceptions.client_error import (
ClientErrorException,
ForbiddenException,
UnauthorizedException,
ConflictException,
NotFoundException,
UnprocessableEntityException
)
app = FastAPI()
exception_handlers = {
ClientErrorException: client_error_exception_handler,
ForbiddenException: client_error_exception_handler,
UnauthorizedException: client_error_exception_handler,
ConflictException: client_error_exception_handler,
NotFoundException: client_error_exception_handler,
UnprocessableEntityException: client_error_exception_handler,
}
...
If you raise any of these exceptions everywhere in you FastAPI project FastAPI will return a client error response based on the excpetion.
Example Usage
def view_or_somthing_else():
raise ForbiddenException()
Credits
This project was inspired by the work of Mr.MohammadAli Soltanipoor on OpenAPI.
Metadata
Release files for basalam.backbone-api 0.2.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| basalam_backbone_api-0.2.9.tar.gz | 9.0 kB | Without provenance | Details for basalam_backbone_api-0.2.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| basalam_backbone_api-0.2.9-py3-none-any.whl | Python 3 | none | any | Details for basalam_backbone_api-0.2.9-py3-none-any.whl |
Total release size: 26.2 kB
Release files / basalam_backbone_api-0.2.9.tar.gz
| Download URL | basalam_backbone_api-0.2.9.tar.gz |
|---|---|
| Size | 9.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d5bf1e5dc686a4e696e75651cbb367f7d3f57b2c53d40f4c80f6ab28c96b6ea
|
|
BLAKE2b-256 checksum How to use checksums |
f518751bce571ac87684a946c7baf2d67b28fd95f3f946c129241cf0896288ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / basalam_backbone_api-0.2.9-py3-none-any.whl
| Download URL | basalam_backbone_api-0.2.9-py3-none-any.whl |
|---|---|
| Size | 17.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
913bc709fd7cbacc4d4f1d72273012a8e1243583a7c202e0e366a31d2f30cc81
|
|
BLAKE2b-256 checksum How to use checksums |
dfe5442910a1173678873cd2bbb853bbcee0fb75ee3b90aafa4d51beda430138
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for basalam.backbone-api 0.2.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.