Document

class falibrary.library.Falibrary(app=None, **kwargs)

Parameters:

• app – Falcon instance
• kwargs – key-value for config, see falibrary.config.Config

spec

get the spec of API document

validate(query=None, data=None, resp=None, x=[])

validate query, JSON data, and response according to pydantic.BaseModel

Parameters:

• query – Schema for query args
• data – Schema for JSON data
• response – Schema for JSON response
• x – List of falcon.status_codes

from falibrary imoprt Falibrary
from wsgiref import simple_server
from pydantic import BaseModel, Schema

class Query(BaseModel):
    text: str
    limit: int

api = Falibrary(title='demo', version='0.1')

class Demo:
    @api.vaildate(query=Query, x=[falcon.HTTP_422])
    def on_post(self, req, resp):
        print(req.content.query)
        raise falcon.HTTPUnprocessableEntity()

class falibrary.config.Config

DOMAIN = None

service host domain

OPENAPI_VERSION = None

OpenAPI version

PATH = None

path for API document page

TITLE = None

service name

UI = None

UI for API document, ‘redoc’ or ‘swagger’

VERSION = None

service version