Skip to main content

Build REST API for Flask using Marshmallow.

Project description

The Flask RESTler – Build REST API for Flask using Marshmallow.

Has builded support for SQLAlchemy and Peewee ORM.

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!'


# Regiater 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-0.2.5.tar.gz (717.6 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-0.2.5-py2.py3-none-any.whl (738.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.5.tar.gz
Algorithm Hash digest
SHA256 b739c39c7a628aef0ecfcbddb7429f47d521f24767c2dafeaa175427f71d09a9
MD5 8be6a544ec75de9936fd5ab174a6146a
BLAKE2b-256 273fbea6b9b2b233206ca7cb3951ec9ed8094293c721c2b8f056e3ea88536235

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e6a200b5d93fec5f39a0b9040f7d7834b5bbc0a9d9ef1c94ca50c8dc21a2dff3
MD5 41690e6666f7ca5b187f5ea1372cc6cb
BLAKE2b-256 5c2358e91db5064f7f88a693064f964190588aed8be141ad0fa61f9e57d2a2be

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