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

Uploaded Source

Built Distribution

Flask_Restler-1.16.1-py2.py3-none-any.whl (467.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.16.1.tar.gz
Algorithm Hash digest
SHA256 d831b2b9c9a18045f61657d78dcb3bc19edc592bb92ca74153c2b9bbce08348a
MD5 2f52be36882765077ea07241072ea84a
BLAKE2b-256 ad1e069d673527f26a65b26acd8836ef0368ac5afc330ddf5493594c2776fc9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.16.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b5bd736009a401294c23bc10947aee59cd3db462099d1b922a70ce7cbf11c292
MD5 f27c0bdfaffb607c6781bf969b09e262
BLAKE2b-256 b2aa87a27f76f08a16eebc527a4c1a3b9e2be0a448b41b216d7f0c7fe6215249

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