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

This version

0.3.1

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

Uploaded Source

Built Distribution

Flask_Restler-0.3.1-py2.py3-none-any.whl (740.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.3.1.tar.gz
Algorithm Hash digest
SHA256 980bc83fa66cd9cbd1a427e43f80b51713a30c1c9f85b7c8e666ea5fd8fcdbd7
MD5 d80513ebb7d5e7c1f6e9e6868a127be3
BLAKE2b-256 888218118d46b5c6bbe5b08b5218669f1da3a374d326027d65267d93b245d28f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac3f76d47a38060653e5019af267daa40d45908d005901387b0d8e6d7acb9ecd
MD5 045e4a5fe21b0a87b8bf9531f2bf0e5a
BLAKE2b-256 6e7d808e689e0b702a7451d6de7399e6983e083662741529ed39158691efdb14

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