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

Uploaded Source

Built Distribution

Flask_Restler-1.12.1-py2.py3-none-any.whl (466.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.12.1.tar.gz
Algorithm Hash digest
SHA256 d632b85648c7b6b403584d907056901c5f9b0bf8973b4910a79446f0ac5501b1
MD5 b999403410ef08af87a34dddaa665439
BLAKE2b-256 a477cc5a88bfb9275a246d1d12a1444d18af386eb97632c0ff786e58c9605684

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.12.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ddc525ba2328eb2ea03b0e9182179aa2ad3f91e65c6c86d37e120d350efee5e
MD5 9efb54d3e797fe35c4844ceb903c3286
BLAKE2b-256 1b7840020168d75a3d4028c3cbb39b9cd7fe845f9b579dedcfe849badeb8f74e

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