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

Uploaded Source

Built Distribution

Flask_Restler-0.2.0-py2.py3-none-any.whl (738.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3fd9e18788ce08793df0df16bf6b820277adca1d105903978e2816b64efcb2af
MD5 4a314503ad4ac1b48737a4d4e776fbcd
BLAKE2b-256 3d64f21894cfaf3f2255f8e9a10de555f37ac193537c93abc433c4a9f81bb718

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dfbf2dc5d2a6c953b87225f0618415bb8ae779158e95e43e2ca6bd05410b1c62
MD5 48e6431404dc06ab9d70a2aaa5bb10f9
BLAKE2b-256 65f3fbfbc3327bb62b8a7ca8f265e7a8cda7bf1b4a886723a5e3bfdcb23be944

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