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

Uploaded Source

Built Distribution

Flask_Restler-1.16.0-py2.py3-none-any.whl (467.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.16.0.tar.gz
Algorithm Hash digest
SHA256 a2d860deadb0000b6ad72190ffef07635df62bec3a99742af7569b8e1aa9ff05
MD5 273a0154290114343bc6cf6f6f49f932
BLAKE2b-256 fa1cd0ee80fabf9306ea4447e6385eb695adc47d1257b3323b5c8bbf4dd0cb29

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.16.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 78eb050fda423e87112d1a182c313ab7a9b5836872f20c0ebea3da7151f2e7b3
MD5 a6885e30a3e56eeb8482b292cab4761f
BLAKE2b-256 1e40bf0d66fbe70fa5b6c1f7f39613d12254afea52422727e4b41cd3a45f4c69

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