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

This version

0.4.6

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

Uploaded Source

Built Distribution

Flask_Restler-0.4.6-py2.py3-none-any.whl (741.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.4.6.tar.gz
Algorithm Hash digest
SHA256 d8108df9d4a16b7076bc5d1081bb6793ee3118e85126ce21a244d37977070395
MD5 25c5ea445e65e7cfbfec37da110601aa
BLAKE2b-256 d5fb68fc300d8deb0ccad3aaaa87ab1a280630f3e3dbd17c86e10bb7a03dc16d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e7c1f7213117879cca1091b6015d6b67723aaa73a323a88c5fc84cdab172ff3e
MD5 f1ead7fc36c370ecc600decc61e49855
BLAKE2b-256 1ecc0ebfc500b8f07583c37a35e10973b12b5be0adf8106fa9c71d1010312bc7

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