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!'


# Regiater 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.2.0.tar.gz (720.5 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.2.0-py2.py3-none-any.whl (743.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.2.0.tar.gz
Algorithm Hash digest
SHA256 bd78f2d4c7913ed8d894c05f96f47e247e9a90cc43738f7f69544b3c256e0b22
MD5 fee9fc8ff8acf0832446a7782f1666f5
BLAKE2b-256 0ed0936f5abebf15f5810575bf7174c74ae3199beba3beb250d418c2887dfe02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b85fd7e828220099441d281ff6a6069d98511f6ec5963eb0521137653fd4a053
MD5 4672486225bae1b5ad64d3726520fc06
BLAKE2b-256 ce058eb20db46ac3f993bf6a9ef1d02ab789e71200089402dde7a2cc9d0ecfb3

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