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

Uploaded Source

Built Distribution

Flask_Restler-1.4.3-py2.py3-none-any.whl (743.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.4.3.tar.gz
Algorithm Hash digest
SHA256 183a4ea0b251ea9f098e684fd1eef372f600d8424ae027d83bbb91c5e269b930
MD5 7cc97d2624f5813ab6d64509d7dfdd2f
BLAKE2b-256 9d56a636da7eea13eabb93d4d31921abc3265a5593af32553edc4c75106d1a79

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.4.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 43bf6157c0e7a1a6d6d9b66d55eb4cfd3a2290a08b36803e41094f60aed937a6
MD5 4f51c939160646177cc1febe299b8b0a
BLAKE2b-256 ef596036b99c659bde988529cbbd12ade4207a1e8c5c45d0f1763587fd68e3de

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