hapic/example/example_a_flask.py

# -*- coding: utf-8 -*-
import json
try:  # Python 3.5+
    from http import HTTPStatus
except ImportError:
    from http import client as HTTPStatus

from flask import Flask
import hapic
from example import HelloResponseSchema, HelloPathSchema, HelloJsonSchema, \
    ErrorResponseSchema, HelloQuerySchema
from hapic.data import HapicData
from hapic.ext.flask import FlaskContext


def bob(f):
    def boby(*args, **kwargs):
        return f(*args, **kwargs)
    return boby

app = Flask(__name__)


class Controllers(object):
    @hapic.with_api_doc()
    # @hapic.ext.bottle.bottle_context()
    @hapic.handle_exception(ZeroDivisionError, http_code=HTTPStatus.BAD_REQUEST)
    @hapic.input_path(HelloPathSchema())
    @hapic.input_query(HelloQuerySchema())
    @hapic.output_body(HelloResponseSchema())
    def hello(self, name: str, hapic_data: HapicData):
        """
        my endpoint hello
        ---
        get:
            description: my description
            parameters:
                - in: "path"
                  description: "hello"
                  name: "name"
                  type: "string"
            responses:
                200:
                    description: A pet to be returned
                    schema: HelloResponseSchema
        """
        if name == 'zero':
            raise ZeroDivisionError('Don\'t call him zero !')

        return {
            'sentence': 'Hello !',
            'name': name,
        }

    @hapic.with_api_doc()
    # @hapic.ext.bottle.bottle_context()
    # @hapic.error_schema(ErrorResponseSchema())
    @hapic.input_path(HelloPathSchema())
    @hapic.input_body(HelloJsonSchema())
    @hapic.output_body(HelloResponseSchema())
    @bob
    def hello2(self, name: str, hapic_data: HapicData):
        return {
            'sentence': 'Hello !',
            'name': name,
            'color': hapic_data.body.get('color'),
        }

    kwargs = {'validated_data': {'name': 'bob'}, 'name': 'bob'}

    @hapic.with_api_doc()
    # @hapic.ext.bottle.bottle_context()
    # @hapic.error_schema(ErrorResponseSchema())
    @hapic.input_path(HelloPathSchema())
    @hapic.output_body(HelloResponseSchema())
    def hello3(self, name: str,hapic_data: HapicData ):
        return {
            'sentence': 'Hello !',
            'name': name,
        }

    def bind(self, app):
        pass
        app.add_url_rule('/hello/<name>', "hello", self.hello)
        app.add_url_rule('/hello/<name>', "hello2",
                         self.hello2, methods=['POST', ])
        app.add_url_rule('/hello3/<name>', "hello3", self.hello3)

controllers = Controllers()
controllers.bind(app)

hapic.set_context(FlaskContext(app))
hapic.add_documentation_view('/api-doc', 'DOC', 'Generated doc')
print(json.dumps(hapic.generate_doc()))
app.run(host='localhost', port=8080, debug=True)