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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.12.3.tar.gz
Algorithm Hash digest
SHA256 4bd1b140b9ac7a35710011230b9830d2c5e7a298d32f65f9d19fcd2341ad7b8c
MD5 9e685e037913de538d6ecec79692e55d
BLAKE2b-256 84b81eeb9e8cca3b0803e9afcc095cd7b8467d9ecbd40fd09289b454c3a7e1a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.12.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 21d77b53ffb5f64189003d319a99c9893176997bfaccb52b181a49f7a0c750bd
MD5 689aa992a7241d2c541fc42b2a25c0d0
BLAKE2b-256 d88bbb307f439b9c036980ad89fe634f063fa86d1be2e99832308e225fbe510c

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