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

Uploaded Source

Built Distribution

Flask_Restler-1.8.2-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.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.8.2.tar.gz
Algorithm Hash digest
SHA256 7cafe465bbbcb7717a5f04ff02021a7db4412816aa1b3385fa0648fd9ca16a39
MD5 2d218db8a8adc162dd49ee7c3b6f9ab8
BLAKE2b-256 6748cd16eb40dc00c7e9d1b17817f241c780b70d9556336b3425257d047e32ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.8.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4ff98096f974c287e5f46c0a659dc80a0ec8ca34abffa8b2373b899a18a50da5
MD5 bc3fcae86a1e6ee7bb205dbf28bd6d1e
BLAKE2b-256 76faff524936a6ab5a000c7b4d263d71b6ce254ad17bde65431b3b8f9d2ee832

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