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

Uploaded Source

Built Distribution

Flask_Restler-1.4.0-py2.py3-none-any.whl (743.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.4.0.tar.gz
Algorithm Hash digest
SHA256 f229a89b7bc0299630bf2b146ca99e82364ff85bdce53995f23a112b088e86d5
MD5 59d37b8638a99a9a1cc4fdcce4368212
BLAKE2b-256 d97383c1ae4b2da897e53bcd604e309470b7918919a70e6bac104680bd36db80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ba9f1660fc70540077bf276f4544129b1c28c71f8cec994cec1d8403a4a87fce
MD5 88e9b195aa4728bb16079a10848d33f4
BLAKE2b-256 cb27870ed4335963ea242bb0a6a49341d4e9b367656ee57e482f4bb6e9575637

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