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

Uploaded Source

Built Distribution

Flask_Restler-1.0.1-py2.py3-none-any.whl (742.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.0.1.tar.gz
Algorithm Hash digest
SHA256 7beaf7dbe7b5b73cf42d8929d9d9b291288e26fc1232dbc46b49f0ac51d55fea
MD5 c24251321bd280ca11879621488926d1
BLAKE2b-256 a4ae4b347f55152de184ca4e544dca356ebe5f93c8b3f229bbc006d2455b08a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 06798daee510a64b3a3739ae6a375b0603ab3c78c5f0a917c6420e105415a4ad
MD5 9520c0703a11be52bd54c207270fa648
BLAKE2b-256 f6be56b60a822cd5b8a94e691f3c76df64412d30463f317cf7e65de5d3cf6c00

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