Skip to main content

Build REST API for Flask using Marshmallow.

Project description

The Flask RESTler – Build REST API for Flask using Marshmallow.

Has builded support for SQLAlchemy and Peewee ORM.

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

This version

0.2.9

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

Uploaded Source

Built Distribution

Flask_Restler-0.2.9-py2.py3-none-any.whl (738.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.9.tar.gz
Algorithm Hash digest
SHA256 fd053a65c69867329a27a0d05577d9dcbfbd65fe9cbf2847ff97080181f355c2
MD5 dc9d5e5c51774c2df372ad097ea56ac2
BLAKE2b-256 05375b834b82c52db8b93817379404920983e325396af5eb8a21cf877bb42890

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7eb94d74c70e99258f559e4cb6f3dac26998de334466829b3cfb36c3341195ab
MD5 94e037dfad24713cf2f398e4850e0c19
BLAKE2b-256 c65e18a502b65d600f976ad72a40284dc01b0d4d875db7c2265e522e9f6a46da

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