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

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

Uploaded Source

Built Distribution

Flask_Restler-1.12.5-py2.py3-none-any.whl (466.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.12.5.tar.gz
Algorithm Hash digest
SHA256 2202493969f22c1252a1dde1af1e26bf19cfaed58a23ffe5d662895de65671ac
MD5 fa6e0ca8ec56784fab7fb1f0a226d1ff
BLAKE2b-256 864ad0e1d149f74f6393183aa662740f11e92c37f95aa9595d9a3aa790dd0643

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.12.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 55915271170ba935ab0f6fbc3a070c643de86be4ebfdb0acd568c7891ac2f5b9
MD5 5830ae91c232a0a5f734ad2de2105d85
BLAKE2b-256 632522c78c608a8db84ca9ef9b372a3df44b7190f18996dfe8e4b348e9460791

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