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

Uploaded Source

Built Distribution

Flask_Restler-1.0.2-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.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.0.2.tar.gz
Algorithm Hash digest
SHA256 1886d2e1ed0798bd981a609fd943eb49e4d9548e20c2e824782697c29a946d14
MD5 d997d29ed8bdc5e8fd55e2a3c66d9f18
BLAKE2b-256 9bb31617b1453bf48d45ab8a3e7d6fb35ca8f517dceb316d8fd31147bad4c781

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c9ee1fffccb14e882139d2b3b3bcbf40586503c9296817e2afad7a6b055ff7d7
MD5 902ef29deda5b44762d56d3aec07a04a
BLAKE2b-256 be782ba27a0881e42ad7ea2b1c0c0c40da761cd9149901ac57522624b8e13ec4

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