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

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

Uploaded Source

Built Distribution

Flask_Restler-1.7.1-py2.py3-none-any.whl (745.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.1.tar.gz
Algorithm Hash digest
SHA256 6fd78412c6a532c562f44e1c877fd7c93e70dce63347d6bc69f0457a52a137c2
MD5 3ab8a37446cdfaebfe31cc504465832e
BLAKE2b-256 087f720a668cdab65afc2031127caa63a01acf521b2c7e68321c40d0991bf0c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d8fefe2998cf87bf5b2269f3116e11302f35186d5827a41a60f2fcdd8426d346
MD5 375fa28a3a60c9968db9e2942d7a502e
BLAKE2b-256 18503bb00dd7cee27a0a700834398ed756a5970d5d0378bc21d176acd62608e9

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