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!'


# Register 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

This version

1.7.6

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.7.6.tar.gz (722.2 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.7.6-py2.py3-none-any.whl (745.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.6.tar.gz
Algorithm Hash digest
SHA256 37c1f50c6fec7276c71aa5f288149f25c6bef72dd7c56564460fc391c7d016f7
MD5 0c325a8515ccfb81f2c160c2c40b8217
BLAKE2b-256 2a2899617dd80db5e161c12f031b4e68b8da35f560421a54f8870a28b232d5dd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b68b79046169292add6c9d1025740a9706c514ab730a4db2a2ca8589c6942ad0
MD5 5faf83f0447dbd6e945e136ea5480111
BLAKE2b-256 187b212cf231989b728ccf747c70934eb06a05da8ec23b2318c963f93af5400b

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