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

Uploaded Source

Built Distribution

Flask_Restler-1.14.0-py2.py3-none-any.whl (466.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.14.0.tar.gz
Algorithm Hash digest
SHA256 7087252637a9868ddac79c619255984bb68b52e2539e3288feee8df478571dbd
MD5 5fddba66956adbee7b3bf7eee97a9c90
BLAKE2b-256 f5daf7f76a96eb05786f15a9ff5a2a5f8452bff9f408cab04da2aa91c48fabf9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.14.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 821449510bc4e80d68dfb2de2278bf4a16c85dccc5c7f9e2b2e7fd21d3e08a77
MD5 e06ef25ecdd796fd0a20c78e8b9eade9
BLAKE2b-256 a55298378bad53c227d7fad52625a8945d236ec05e82e2c1140c5a76b26a41f1

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