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


# 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-1.1.3.tar.gz (720.3 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.1.3-py2.py3-none-any.whl (743.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.1.3.tar.gz
Algorithm Hash digest
SHA256 e9c4715d69061e0ed65c803cc0f3d1c6db07d24b8e6e7ac3bcd5654ba9c30614
MD5 762b388c8647a1440cca1e4789f37dca
BLAKE2b-256 82fdae1330ee1b0b47aecb587d68e9c527351dfee354b0e3a475723c7397eb2d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8b663d3827bf9de07fbc0ef321d10105b2b98abd1d6fd6b68fd84c4b407ef24d
MD5 1df7fd9b1424b82049343a7bd0e6d1cc
BLAKE2b-256 e8931c3588aeaface00c0cde80f4bd0f20259da17863d2a971e207f82e0bd8de

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