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

Uploaded Source

Built Distribution

Flask_Restler-1.11.2-py2.py3-none-any.whl (466.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.11.2.tar.gz
Algorithm Hash digest
SHA256 843e041ec2aeed8b0ecc60084da72ef6131cbe3054f6359e10d014bbd9233e16
MD5 20030149f0483c02cdb58b4d3a75652a
BLAKE2b-256 f8ea8c85d1b40880e448825fadc5da96c8319fdb15ef4cfd811fa5156ea82f8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.11.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5b5b86841fdcf58af9a7d723208ff0bf1d87f40b7b14808c80d8bed4e36dc0dc
MD5 f3da58826421dede3b94aaa800c5a29c
BLAKE2b-256 3dbd34efe6b4e23bc0a84fd14287c936c6ee679773cd84123c529e01b6259f69

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