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

Uploaded Source

Built Distribution

Flask_Restler-1.8.1-py2.py3-none-any.whl (745.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.8.1.tar.gz
Algorithm Hash digest
SHA256 addf1f13f18ce1a08ce3d3a4223dda2dad0dff0115da570c2523dee7c32fda33
MD5 f1a9e0f6b0ab7793e6e27c8943412649
BLAKE2b-256 7bc4aa01f5bf58992f94816ac7c3a9fddc3b40c1f4a4747e2972472c7576c35c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d89059e9644f125ea31b8617c2ee0a184a5397e1d314f586804238ef4c378d49
MD5 70e9a141f6d2a248a362217fcd1341e3
BLAKE2b-256 21d1feceba0cbd7d8298f302cb1b98e1944a17792028f37206a852805adafad3

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