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

Uploaded Source

Built Distribution

Flask_Restler-1.7.5-py2.py3-none-any.whl (745.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.5.tar.gz
Algorithm Hash digest
SHA256 d5c257adaa96f7a00ff5c01970315fea9fd1930da6065d0ecb6479b4a11f4866
MD5 299685426a26cb3871369a4b4000f8c8
BLAKE2b-256 1ac7d626dcd95156b0070570bf1dba976fcb1a399b3e2496e0366e20608ff6fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5b9ee7abb0b590d93d76003096a7f6c9fec05b3e3f3b4c13da3756474f775301
MD5 05cef3804a98886655a84261d74b750a
BLAKE2b-256 4c4d1e0a63aa700822cacfdcb8282d9ed97e706056f808d3c6bfc07483312cd1

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