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

Uploaded Source

Built Distribution

Flask_Restler-1.12.2-py2.py3-none-any.whl (466.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.12.2.tar.gz
Algorithm Hash digest
SHA256 3f3fd8e5980348a587b9606bb45d2b2ecc8950b3daa5686738e79b574531ff98
MD5 c9892506dfd1bd58203bb6b1c2844660
BLAKE2b-256 7c99b9b8b7f0937679c8c9f72a60e94b6b22f5579e553ff963c29033ea941e67

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.12.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 21afcc4ea9a4f1540ca1756e163303e6f5d056b2ec78e32f9663878c96f5379f
MD5 fed4f9dab67fee62d3b5f3c8a6e30ada
BLAKE2b-256 674e43244cc014c8fe656dee8800a7bf3a9ca7c4b541ef4ed567964b3cabc300

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