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

This version

1.7.3

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

Uploaded Source

Built Distribution

Flask_Restler-1.7.3-py2.py3-none-any.whl (745.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.3.tar.gz
Algorithm Hash digest
SHA256 95e5f811e9a32ae5b6f00df249b51c5177b12cc47e7bb90257468b6dcaadd4de
MD5 570fcb64b63114b702e3138beda8f70b
BLAKE2b-256 36e1321615573a7053e3a0108842cdacce86cbd5b3af3044d7f8a016cfa28017

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ecc6b8fc8e53c846806e032db4d5f83ef60dafbf4aa79e5d245b3cfd6d438c56
MD5 897990eefa4d2fa061edca33e4a5eba1
BLAKE2b-256 814f78fa3c4afc210a4ea7db97f2761d8eb7d2328447a7a43dc75d16eae576c6

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