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

Uploaded Source

Built Distribution

Flask_Restler-1.6.2-py2.py3-none-any.whl (744.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.2.tar.gz
Algorithm Hash digest
SHA256 effce8060788f3539ad3484beb1f107a147c8cd3749008d81230ba5ea2373546
MD5 8f6aa997dc1780959fa03eb493fb7f61
BLAKE2b-256 b8421d147bd00a338a3bbdca5c600ca8b2ecf6421b5f2f04e0118e6099ef6685

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 27358dfd60a5d2c57eafe45299aadb30f4db6f037824cce75aaabe6a20a4bb0f
MD5 5c7d03a22b4a620401f9b16f0f095146
BLAKE2b-256 1ae2c539f5cb3363c8ab61a3819c1af5aa2c6e97d1b62128396f212c6b35d024

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