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

Uploaded Source

Built Distribution

Flask_Restler-1.11.0-py2.py3-none-any.whl (466.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.11.0.tar.gz
Algorithm Hash digest
SHA256 c18de00672f507a0b99bcfd0a1d5171e51cd3ef0177f68c7475e5b97bfc2f086
MD5 579e86fe7b765519d9609d68a4c0b5fd
BLAKE2b-256 cf126c36e4f6a13e31c92f920ff88d21cec1861d94ce142a13003b567900f6c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9343be86fa2669877a295d38641d4bc69dbc393ce9953af97fcd748ce93881b2
MD5 84d8060640dd2d7d5efb94d3cfeb5469
BLAKE2b-256 af22f0a853f90d80639b178544e4523fdb778be0641354a3b6ec74a93bb4f9b6

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