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 and Peewee ORM.

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!'


# Regiater 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-0.4.2.tar.gz (719.3 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-0.4.2-py2.py3-none-any.whl (741.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.4.2.tar.gz
Algorithm Hash digest
SHA256 94665d5fda78491d60804cd2449e7a120b4bccb0760fe309a95f184bf5d7550b
MD5 7d26a691d8720f49f3d5d0d4a83ff26f
BLAKE2b-256 007ac5fb961bcd6d350c35485f5df602455422ae945e41a3377b9562c7fc10af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6b0dc04dec6cf0e87a12b3a6eea77cab64c6900d4268048696c47e72f81fe36
MD5 2d4d886171d207316fe21cf8e3977030
BLAKE2b-256 25e9e7e320f0ddc72b543ba9fa639295fad9366279ded40f4b57a0c755118c3b

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