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

Uploaded Source

Built Distribution

Flask_Restler-0.2.6-py2.py3-none-any.whl (738.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.6.tar.gz
Algorithm Hash digest
SHA256 70e70aa17bbbfde720b1a726bea04f92d92d6308a2ff8bd7113c17c8d07777a1
MD5 9e5d8d927c175d12723f196132388cf1
BLAKE2b-256 afcf0ef907fe9b21cedcbf0d45f8e6dec3fb469785b90086a46bb15ce5537497

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9cc82f302598eea32eb19f9583861fc9d2cbfa381e1c95cf564a9120c880fe2c
MD5 4408bd280a0e54be8f29c62236df08ac
BLAKE2b-256 13ac3a41ffab5953fd8a39c2bcb278191644e0ff618ef7785ea052d7693dbb35

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