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

Uploaded Source

Built Distribution

Flask_Restler-1.10.0-py2.py3-none-any.whl (465.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.10.0.tar.gz
Algorithm Hash digest
SHA256 adc9467bff14a7e5aaa1005c3a7dbfad7a7c8cb8b8c3ccbde4f1a816b4bf6aae
MD5 2cbef87340b1973d1e9c2f953d974650
BLAKE2b-256 3bb97b8475b7122188de7accdfdbc11c7760143f813c0d4403de87ede5743eab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 84863d774c86239b0047e4cab7a18200b06258de69adf88ee0bdcb6957bf445a
MD5 8138ea6b7f3d32942f742a33c5858399
BLAKE2b-256 e23fa32af701b6d6019773ded2b07677c35a113e242ce20871135c90f8f86628

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