Skip to main content

Build REST API for Flask using Marshmallow.

Project description

The Flask RESTler – Build REST API for Flask using Marshmallow.

Has builded support for SQLAlchemy and Peewee ORM.

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!'


# Regiater 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-0.2.7.tar.gz (717.7 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-0.2.7-py2.py3-none-any.whl (738.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.7.tar.gz
Algorithm Hash digest
SHA256 c4d7411f24c44a0df1b362311471540bed1db03df2aad11a6dc681f313dd0c7c
MD5 c64ef53e4c18409e5a9b76d1409e05d9
BLAKE2b-256 ecee111286975b5814e9f6722998929d4421f9cf8932d3ed16655d9c1058cb26

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 21b3eaaae9db926bb10d7af662601c6b5c0d59386e4b330f55f30f75dbdabad0
MD5 a454d0d312845101ec68c17a624ecacb
BLAKE2b-256 62c428362187123d7b893dccc0877a428c0ebdf7c736229958f75498d994288c

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