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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.13.0.tar.gz
Algorithm Hash digest
SHA256 2c4ad2fe8c78f2ab3160cc22c1608d1c556727fefbd24616598335d9dbb8005b
MD5 8786ff857a6e276663b322f75d83e8c8
BLAKE2b-256 4424835f3ca489b0f4f348201b81786ce1a0b74204e36e70f6b3974bb7822afa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f6a91f741f77deec55d298ebfddc6834815a85eb6758931217f810131c23bae7
MD5 b988c609569fb5ad88222462c2e9a02d
BLAKE2b-256 7d59f43e76c7e6dff80698e1881be388700610930a43cfa54ee0156a303384f9

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