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

Uploaded Source

Built Distribution

Flask_Restler-1.15.2-py2.py3-none-any.whl (466.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.15.2.tar.gz
Algorithm Hash digest
SHA256 63f44a379e2834d5904615e5b3ba4fe4bf40d3dda07c088aeb183f36e8ed294f
MD5 a621ffcc93c39a46b421bfac8504dfc4
BLAKE2b-256 d852061d69a114d25dd0f412cf2bee22c3c4a33cbb6000457eb41b9222264da8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.15.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d160667f2fd7a70dce4340b7f7d8373a2f56f29cbb7ae20b6d7cee1c6ad09a5c
MD5 ad481a6186c772ce2d6ec38ef482e7bf
BLAKE2b-256 41a1a78146032863669b241d8c9893841814d5e38ca50ab70395e1a141c214ca

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