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

Uploaded Source

Built Distribution

Flask_Restler-1.10.4-py2.py3-none-any.whl (466.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.10.4.tar.gz
Algorithm Hash digest
SHA256 587a07aa7cdcb7750d94d0b552fd51007c09398912aba5b83dcd1cf9db6eeac8
MD5 f1cb041ad729521e5bed05531822471f
BLAKE2b-256 166465201802bd653e7244ed9a14f6db6db9b72b3f49f47ec9c5f9237bd70962

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.10.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 843b519dc64df44f45ab0957f18af0a8067fc74a81bcbe0b3a07c9c4ee28c6ec
MD5 bd51671b5ae1708544c54afdd27be1a0
BLAKE2b-256 70eecbdf099f97f0353fbc5b901f8a566d2e36e3c48edda8b56fc71e15f06db0

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