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

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

Uploaded Source

Built Distribution

Flask_Restler-0.2.1-py2.py3-none-any.whl (738.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.1.tar.gz
Algorithm Hash digest
SHA256 85352e7c09a92ec262a7f646f4a4c75dd7da48ab726edb31b344c4d7da600f00
MD5 54efbf7bfd3328bddba9468224bf0368
BLAKE2b-256 64b68457fe232ff0b19041baf8781c96ecc1c823185f5acf07ce94a8965f57c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 41721a7622f521119f47d8424ed2c3fb9a052a9771ad76e757acac59e0741f80
MD5 b9dc40fa8e527624bae5a0392c016c07
BLAKE2b-256 a61ef6bbd96f63586cd51f1ae9a0d41e4b044e845c47c201eb50b9329cbddaa0

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