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

Uploaded Source

Built Distribution

Flask_Restler-1.5.2-py2.py3-none-any.whl (744.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.5.2.tar.gz
Algorithm Hash digest
SHA256 de74575afef1eefa64ce61d80dc6581581f4e309910258688cadd86e039d2497
MD5 72569e00d1585813a3232534a736b707
BLAKE2b-256 5792d1c57afb60ab599288b706910a7c11399a8421fc2612db204475548602a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e39ac2dea41c7ea5995eb30284f2f8990d6c02d596077f7717a8f623683d9a43
MD5 a622d97774eb528b6793ceca53c2de6e
BLAKE2b-256 41175c97efc5c6d7c81a99c9e7d569a27fbc8472481e6df6d8082b8e68116f42

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