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

Uploaded Source

Built Distribution

Flask_Restler-1.9.0-py2.py3-none-any.whl (465.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.9.0.tar.gz
Algorithm Hash digest
SHA256 4828ac29100a60a5536f7bfd869b3d6f4f573f9cd4e5c094842b29e72c370434
MD5 f9ceb98871597ee30de53a170dfb0134
BLAKE2b-256 05f366e892cf88e0cad037892c1fea004fd5207a631c34257be67b70c26a6c33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a7106c307f52b8aab743fa4c648e5ad111b3e94a9c0129173996fd716bbedff8
MD5 104df152e3680bf6355da357306503de
BLAKE2b-256 5eeece95d30703a1aa987566ded38e6793f3efc5f6a6ebb97e114bd5b879835a

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