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

Uploaded Source

Built Distribution

Flask_Restler-1.18.0-py2.py3-none-any.whl (467.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.18.0.tar.gz
Algorithm Hash digest
SHA256 9d424bda91cf14fed538e8759ee59a37b61ff755227c7addcc1f36543f017dde
MD5 d12e27658ca2d768e7678bcd7320ad59
BLAKE2b-256 52869f9dc28223ade87c8eecdedfc06ed032fb2d0024c6213dd60338f2844bfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.18.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03ba29d88377a5c5e9860dee11d980e3aa54dbdcbde3260e5b5ba79adfe64221
MD5 b594138bee1e2cd3c5e037175a06bf4c
BLAKE2b-256 9bbbb077e14c302ee19a58e1011332c728f11e6f51af40cf7cf8c0c6bea17b36

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