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

Uploaded Source

Built Distribution

Flask_Restler-1.15.1-py2.py3-none-any.whl (466.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.15.1.tar.gz
Algorithm Hash digest
SHA256 8be6f54c86f2020a25089d6c716ed02918356a036c1540ad9416882aebfea466
MD5 935ebf6450b5b5840ac495ecab98677e
BLAKE2b-256 320f93133fe4a3e8a415fa542ce2490de59153946580021f7cd1f74a846d4ff8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.15.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fe304276d04486fc117155a9cd9ca715a95fa74475dbe8f0bae8dbefcbc0c276
MD5 579f7c961de4271881844e848f0b7bd7
BLAKE2b-256 fd3a5c0b339af0b96ee65ba9a38b503ea149c9fbe40bf60c8a7b98041db1d3e2

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