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

Uploaded Source

Built Distribution

Flask_Restler-1.17.1-py2.py3-none-any.whl (467.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.17.1.tar.gz
Algorithm Hash digest
SHA256 7ae74c1e1534b43a005297e2aba3fb76cfc224c75b2b0b8f29e23b5e01a7cb82
MD5 de6eabac23a2231b76df332160637867
BLAKE2b-256 186925c3bb08c8a14d3567b300a67c6b235e635462f8b0f7b2800ca79e1e2b17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.17.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f2ccc86135415e225679d7357fa90f4648afbff72539ce01957364842bfc264e
MD5 a724a9e4c9d2f2c5fe540ea948c6b6f4
BLAKE2b-256 caa44961a846e8be068741b5adcec0744ddaee68c8ebc8c5fe09b700f1f4f9be

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