Skip to main content

Build REST API for Flask using Marshmallow.

Project description

Build Status Version Downloads

The Flask RESTler – Build REST API for Flask using Marshmallow.

Has builded support for SQLAlchemy, Peewee ORM and Pymongo.

Example “Hello User” with the Flask-resler:

from flask_restler import Api, Resource


# flask_restler.Api is subclass of Flask.Blueprint
api = Api('My awesome API', __name__, url_prefix='/api/v1')

# flask_restler.Resource is subclass of Flask.views.View
@api.connect
class HelloResource(Resource):

    def get(self, resource=None):
        return 'Hello World!'


# Regiater with your application
from your_project import app

app.register_blueprint(api)

if __name__ == '__main__':
    app.run()

Run the application and open http://localhost:5000/api/v1/ in your browser.

Requirements

  • python 2.7+,3.4+

Installation

Flask-RESTler should be installed using pip:

pip install flask-restler

Usage

Docs in progress. Would like to help? Create a PR.

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/flask-restler/issues

Contributing

Development of The Flask-restler happens at: https://github.com/klen/flask-restler

Contributors

License

Licensed under a MIT license (See LICENSE)

If you wish to express your appreciation for the project, you are welcome to send a postcard to:

Kirill Klenov
pos. Severny 8-3
MO, Istra, 143500
Russia

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Flask-Restler-1.1.2.tar.gz (720.4 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.1.2-py2.py3-none-any.whl (743.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-Restler-1.1.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.1.2.tar.gz
Algorithm Hash digest
SHA256 02be09a5ae56294870595762af6999b00418e1d944a749926548b58225f6656c
MD5 d1f81bed16db02aebd9d20c09f00de43
BLAKE2b-256 d308b0288f0cfb69f065b9e4154c1854e7361d14b0aa915a4c613caf994cf92b

See more details on using hashes here.

File details

Details for the file Flask_Restler-1.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Restler-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 99d9b3651ac6a05f88c584e0d005bb485d54aea6d94dd101cc887611840c8d10
MD5 2f76b199eaa775c0405b1cb8c4a67b95
BLAKE2b-256 bbc1bddde5a54cad91ce68ff14507ed50eadbb64a0183110d53c14f8dd35ec2d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page