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

Uploaded Source

Built Distribution

Flask_Restler-1.6.6-py2.py3-none-any.whl (744.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.6.tar.gz
Algorithm Hash digest
SHA256 36cf8f3cdef6aa8199cc64bc94cb6c925836ffbcba5cff225080390433f02407
MD5 5e5626fc4a3356fe1bae24d366792ee0
BLAKE2b-256 b0e906e183536bc0004f96ef9d89029f70798f6e1116b52da93d3284aa02fe1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 084865fe10028f02e08f9ca3bb6c457697e024ff3c091ac69c8f9a41a3d69f97
MD5 3e2ba6eec5878fe6d8f8e85011314264
BLAKE2b-256 d2b17aa5d46a2446c3a0d76dde3e96105a03252a14fd4d6ed67492c9e82bab2a

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