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

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

Uploaded Source

Built Distribution

Flask_Restler-1.7.2-py2.py3-none-any.whl (745.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.2.tar.gz
Algorithm Hash digest
SHA256 4c9a628e062680ff8cd568a4b6cae56335ed4c06a11dd10fec199a6c9998fda0
MD5 0193541a736c1cb753abcdb66c7596d2
BLAKE2b-256 5a440cd42033a87e4ee5c675d01456a89ac2fe5573db5b2c41202e59976a528d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6a309fb0a7003b61b2b8e1c35c7d7a0ea6185927cb1e75142d338a56e5d5b391
MD5 293f72636e140ef33b6778f07efd22b0
BLAKE2b-256 615273ba7656adf016d0cbf44cb35cb38f3b4dca8ecfb6b69bcc132a5e2bb1d3

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