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

Uploaded Source

Built Distribution

Flask_Restler-1.8.0-py2.py3-none-any.whl (745.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.8.0.tar.gz
Algorithm Hash digest
SHA256 5a47f72c6fb0080a3c9188f856d5b03c1c95378f5b694a82ae1ac8462aabf4e3
MD5 d697386e16374aa22bb20bf9067e9d41
BLAKE2b-256 3614a36fa7663220c3ab6ebc0989de53e2f738103d51e8f1dcb8187823877859

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 574a0c23724e47e8273170b584a8c967d4f7e92936b9a1737822563586a5f117
MD5 e4c510012b652001dd601a7e738e7e5e
BLAKE2b-256 ec223177c651175c17066cb833c7aac3671336efa572c1fc3faba16f263cd0a1

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