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


# 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-1.0.0.tar.gz (720.2 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.0.0-py2.py3-none-any.whl (742.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e2c5fcdb3817ee37abfd8763725331e37b34a307c4b77a44e3cbca7114347077
MD5 e35c536e2aea658f755016a3c443c664
BLAKE2b-256 b3096b9c127e2a5921145cf8e0d1f67ae9a78542a62a27f19e0b1434deee7d36

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ec3c7aa93b9ec8bdfaff73c637bca71d31f8a592c49ba058d10f70af7941ccb3
MD5 997a416ad38d17d337f4b0f39a539a65
BLAKE2b-256 7281c90c5541f7a16ebb9290770b410b585fc056ef45f84598a7d825e0d6ad43

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