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

This version

1.8.3

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

Uploaded Source

Built Distribution

Flask_Restler-1.8.3-py2.py3-none-any.whl (745.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.8.3.tar.gz
Algorithm Hash digest
SHA256 ae5cb7ed03f2a18c7c592b39fb0066c2ae194f5d2c9897aea233103a690467b0
MD5 73dddf542cf1a6b334239aaa0bae59b1
BLAKE2b-256 11b1669ed861b2f679c7517859b722306755d287ba703541427f51ae3046de2e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.8.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f7e667f43495d93a5b5af960a66b15abcef2ba415fbd9a81e9588214426147e9
MD5 92391109f687aaac56eab7939cdae8b8
BLAKE2b-256 2784b9c55bde7e7845f1720af77ee4b2e81bc5e41ff68cac32d54c6322f14209

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