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

Uploaded Source

Built Distribution

Flask_Restler-1.19.2-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.19.2.tar.gz
Algorithm Hash digest
SHA256 ec4b4df76fc1608e9cf18c985d3ce04355f4b18fe98f1d141cee65c2ac78bf23
MD5 f4ab10f9ca13f14e83dadbdbc664d858
BLAKE2b-256 5d35671adff2284dc0b6082b22be7faa568e1074d580104a8baeca6aade916a8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.19.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9ad02b9dac9d278cc5e4fd8a8edb8cf23738b72975134f3bf44808b3017eac3b
MD5 036c16150971e8e227b80170c0a018b3
BLAKE2b-256 16225ddc6c7f1f2576c15d476b359692a1fc65b02df7248bda391f81f888c024

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