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

Uploaded Source

Built Distribution

Flask_Restler-1.6.0-py2.py3-none-any.whl (744.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.0.tar.gz
Algorithm Hash digest
SHA256 615cf8d7cde6f29e257a6d633a5199b4315667748c04e168f23871fa33eeb09b
MD5 02ec3a1418c4d73574e406d0efe7fa75
BLAKE2b-256 9148f8b670e6c0d9a403284c190e4aaeb5cef8312ca5d8de3cdc42e464ecb229

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ddaa02daecac7b2622135c826f98de7b34c1b3568010a99a99983fcc8b7068e7
MD5 c5156d45d9408ee26d0796717260f7e1
BLAKE2b-256 be3e71af4400b79b124c3ae8bd944429dfeceb6c0a420f7e99f6937e34b57d32

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