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

Uploaded Source

Built Distribution

Flask_Restler-1.4.7-py2.py3-none-any.whl (744.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.4.7.tar.gz
Algorithm Hash digest
SHA256 01d578da99473bfe34cda65707ebae121322f13e927e7cbbc4cd7500e386c775
MD5 beffaaaaa87249e3652e741927f4e316
BLAKE2b-256 633b2368954c7bea433838dc9282167b5d649381d5a59a22c25120d83da2b0a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.4.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 455dcbacb4fa61907bd813cb16d75adc0e821c60710a6499766b8a9b46a70b0d
MD5 038717a004306070b0d3b957867a7ad0
BLAKE2b-256 905122c9094121270b2353c2fed12bfedc2ecbb038565cdbd8d500b46be8a8fb

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