Features 🎉
- Add a tag to your API, which can be used to filter the API documentation.
- Add a description to your API, which can be used to describe the API.
- Add a version to your API, which can be used to describe the version of the API and app.
- Provide some other features like:
- `API_id`: A unique identifier for the API.
- `Audience`: The audience of the API (e.g. `public`, `internal`, `external`).
- Tested in Python 3.6 and up.
- Last Version of FastAPI :rocket:
Usage 📚
- To Identify the Metadata of your API:
py
from fastapi import FastAPI
from fastapi_tag.base.model import Contact, Metadata, Version
from fastapi_tag.core.application import Application
app = FastAPI()
def metadata(app):
return Metadata(
title="Hello World",
version=Version(app="v0.1.1", api="v0.1.0"),
description="A simple example of a FastAPI application.",
contact=Contact(
name="name",
url="http://test.com",
email=None
),
api_id="49786b4b-1889-46ec-bd72-27f332436e6f",
audience="company-internal",
)
def app(metadata):
return Application("", metadata)
- We have also a `Problem` class that depends on:
- `title`: The title of the problem.
- `status`: The status code of the problem.
- `detail`: A human-readable explanation specific to this occurrence of the problem.
- `instance`: A URI reference that identifies the specific occurrence of the problem.
- `type`: A URI reference that identifies the problem type.
- `NameSpace` is a decorator that adds a route generator to the namespace object.
for example:
py
from fastapi_tag.router.routers import Namespace
route = Namespace([])