Skip to main content

Flask-REST-Controller is added Class-Based-View(Controller) extension on Flask

Project description

Flask-REST-Controller is added Class-Based-View(Controller) extension on Flask

Features

  • Follow the RESTful design
  • provide of prepare authentication and request validation
    • other class based view library is not provided of validation
  • uniform routing management
    • The existing functional view is difficult to manage. Definition routing Scattered
  • JSON Response Validation with JSON Schema
    • It would be useful for creating an API :)

Installation

$ pip install flask-rest-controller

Usage

from flask import Flask
from flask_rest_controller import Controller, set_routing

app = Flask(__name__)
app.secret_key = '͏?Š|?    èg<Î|ÇæãhŽÖúÈi|î°'


class JsonController(Controller):
    schema = {
        'GET': {
            'type': 'array',
            'properties': {
                'id':   {
                    'type': 'string'
                }
            }
        },
        'POST': {
            'type': 'object',
            'properties': {
                'result':   {
                    'type': 'string'
                },
                'code': {
                    'type': 'integer'
                }
            }
        }
    }

    def get(self):
        return self.render_json(["Hello World"])

    def post(self):
        return self.render_json({'result': "ok", 'code': 200})

ROUTING = [
    ("/", "app.JsonController", "json_controller"),
]

set_routing(app, ROUTING)

if __name__ == "__main__":
    app.run(debug=True)

Just save it as app.py and try

$ python app.py

Now head over to http://127.0.0.1:5000/, and you should see your hello world of json string

You should see a post request result, try this command

$ curl --request POST http://127.0.0.1:5000

You should see that you json in the post method

see https://github.com/teitei-tk/Flask-REST-Controller/tree/master/example For other examples

Dependencies

  • Python2.6 later
  • jsonschema

Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b your-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin your-new-feature)
  5. Create a new Pull Request

LICENSE

  • MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Flask-REST-Controller, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size Flask-REST-Controller-1.0.0.tar.gz (6.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page