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.6.5

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

Uploaded Source

Built Distribution

Flask_Restler-1.6.5-py2.py3-none-any.whl (744.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.5.tar.gz
Algorithm Hash digest
SHA256 0f3fe509e02bd1b7365170e2968209de1a91ea9116ea3d589bf5c1aa0fd87877
MD5 68298addb9cb3fec767019cdaae3552a
BLAKE2b-256 a5621b04eb9f620c28abc238caf25edc0c8d794ad2506341dcfbad4b50182411

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4d6a43acc3decf3a1243864c5e75bfe205735507d0af1c53fafd4de9add49b55
MD5 515d7281e64c5a087330310b9a61555b
BLAKE2b-256 c243033905a188ebaf19d3360d4e812823dfcece3755faccbab9163e7a2eb230

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