Skip to main content

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 await BulkResponse(data=ls).as_json_response()

app.include_router(router)
if __name__=="__main__":
    uvicorn.run(app, host="localhost", port=8000)

Credits

This project was inspired by the work of Mr.MohammadAli Soltanipoor on OpenAPI.

Metadata

Release files for basalam.backbone-api 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for basalam.backbone-api 0.1.2
File Size Uploaded Provenance Actions
basalam_backbone_api-0.1.2.tar.gz 6.3 kB Without provenance Details for basalam_backbone_api-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for basalam.backbone-api 0.1.2
File Interpreter ABI Platform Actions
basalam.backbone_api-0.1.2-py3-none-any.whl Python 3 none any Details for basalam.backbone_api-0.1.2-py3-none-any.whl

Total release size: 17.7 kB

Release files / basalam_backbone_api-0.1.2.tar.gz

Download URL basalam_backbone_api-0.1.2.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e8d2ebf28f16824ffb550a091a7741ca60ed7db95ce34be99b4433225edb5e74
BLAKE2b-256 checksum
How to use checksums
af3107d5fa7bb295ba00fb9b79dc8fe8a123af824b4e9bc7186e1bd302efad8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.21

Release files / basalam.backbone_api-0.1.2-py3-none-any.whl

Download URL basalam.backbone_api-0.1.2-py3-none-any.whl
Size 11.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b4d4ea0ce4898b22073310e181294254635b6dee86947b6685debaeebc11947e
BLAKE2b-256 checksum
How to use checksums
3c6633d4f22a54ae1a2dcc6c0993369574cf92dde68c73e6f0321d96b52aef16
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.9.21

Security for basalam.backbone-api 0.1.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page