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

Uploaded Source

Built Distribution

Flask_Restler-1.19.0-py2.py3-none-any.whl (21.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.19.0.tar.gz
Algorithm Hash digest
SHA256 074aaf36bc92e66bd57fb6e5b30abbd15cd97bad8f69b2119e7e401c6ea5ba72
MD5 d959fe1cc1a9f778bcef5375808a102a
BLAKE2b-256 6cf2d07435f3e5813ed02c4053d6c089a0949c0d06a53dc26f0b6d0a800e858d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.19.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ecf18b19040fa6a7efad2d7960248fa547451728fbb7419404d6d7b1aaafe39
MD5 881c1a4a60c9cbaa81807479f1639bac
BLAKE2b-256 cff72fa525a6f8e59cea479dd98148fc4b15232a8cc748559d546c5f5c541286

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