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

Uploaded Source

Built Distribution

Flask_Restler-1.4.6-py2.py3-none-any.whl (743.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.4.6.tar.gz
Algorithm Hash digest
SHA256 d11504ee4a2e2b7350a9b3ef9b44ae9bad592fb2d0317ec2e960de1293052c18
MD5 8eebbcd35de8347db10fed045a8f611a
BLAKE2b-256 c288e592d94f5579ddbe31ed69eab8bc6876418fd426c5603e32a32507b20122

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.4.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4e38c25c47561c368fea3b874a9a89a5e28acd169c6732c14cfdf7eaecddbded
MD5 af9471586544563ed08f6ef5cf8f21f2
BLAKE2b-256 17faab8895061308805ed48eb0a3e39a7b3eede59a1ba89298fa14114c9c2e66

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