.. falibrary documentation master file, created by
   sphinx-quickstart on Wed Sep 18 11:32:18 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to falibrary's documentation!
=====================================

`Falibrary` is a Falcon_ add-ons for API specification and validation.

.. _Falcon: https://github.com/falconry/falcon

Falcon add-on for API specification and validation.

Provide OpenAPI document and validation for flask service.

Mainly built for Machine Learning Model services.

Quick Start
---------------

Install with ``pip install falibrary`` (Python 3.6+).

.. code:: py

    import falcon
    from wsgiref import simple_server
    from pydantic import BaseModel, Schema
    from random import random

    from falibrary import Falibrary

    api = Falibrary(
        title='Demo Service',
        version='0.1.2',
    )

    class Query(BaseModel):
        text: str

    class Response(BaseModel):
        label: int
        score: float = Schema(
            ...,
            gt=0,
            lt=1,
        )

    class Data(BaseModel):
        uid: str
        limit: int
        vip: bool

    class Classification():
        @api.validate(query=Query, data=Data, resp=Response, x=[falcon.HTTP_403])
        def on_post(self, req, resp, source, target):
            print(f'{source} => {target}')
            print(req.context.query)
            print(req.context.data)
            if random() < 0.5:
                raise falcon.HTTPForbidden("Bad luck. You're fobidden.")
            return Response(label=int(10 * random()), score=random())

    if __name__ == '__main__':
        app = falcon.API()
        app.add_route('/api/{source}/{target}', Classification())
        api.register(app)

        httpd = simple_server.make_server('localhost', 8000, app)
        httpd.serve_forever()


try it with ``http POST ':8000/api/zh/en?text=hello' uid=0b01001001 limit=5 vip=true``


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   doc


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`