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

Uploaded Source

Built Distribution

Flask_Restler-1.6.3-py2.py3-none-any.whl (744.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.3.tar.gz
Algorithm Hash digest
SHA256 12f3c806267ef3a879f2370cf0d6e6a2a545e73fe412531214892ea9743ce780
MD5 b6b3ab91c4c1d2ceb357ad048b98927e
BLAKE2b-256 acb1828f525368243598f2e7ff53cf63f98686e82471044d60c66cc3f0cdc867

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ce6010ff0d6ae299acc9466afffb57f0c8fd156408554ed347681d3f9d952534
MD5 25aa9e9be0ad001e38878c926fec2515
BLAKE2b-256 823c35a4402f89d42a1fe529d358d6472bdb4940275d4731de95bd236efcd302

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