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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.13.1.tar.gz
Algorithm Hash digest
SHA256 25f8d4f6461e103c202778d3e6c76183159a5b5380abf9df226ba3f65e6366cb
MD5 7486d449bd64dcab2e64374dab7716ec
BLAKE2b-256 d57cbae674d01e06d7dab9549eb60e56451db94d1deb66a2d8bbfb6e827d5e56

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.13.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 db8884b7069af4310e1e5f789cdbb36a72e989e0a86b45e8c9759e2521ad2e80
MD5 31440a9616f2e50ef6e57183582e5eb1
BLAKE2b-256 f57f7ebbcb2b25c37b5e75c7f05483c8f0072a424ad4c054112490bc5be989d2

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