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

Uploaded Source

Built Distribution

Flask_Restler-0.4.4-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.4.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-0.4.4.tar.gz
Algorithm Hash digest
SHA256 02c0247d74acf5a7909bfef4f12241f55adb963de7d7c40c8e2c0a4281cc98fb
MD5 19a1117cdac8d64b1190debee093a7ca
BLAKE2b-256 4f5a7dfa050e4f7d22437fdd5b12919ce7916a8b148af2c4ea8a92f5f5cf368d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9ec188aae040ded2bf2ed1077a79a7fdb4e1da530285f73cf23498f0ec4c6a74
MD5 8892de0628edd5b95ea2012db9644b99
BLAKE2b-256 4a35f8b0c602a1468167df1ff024a372e9ea62585934b4b3ebb821a38c0382c0

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