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

This version

1.8.4

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

Uploaded Source

Built Distribution

Flask_Restler-1.8.4-py2.py3-none-any.whl (745.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.8.4.tar.gz
Algorithm Hash digest
SHA256 3e12ea8ed0da4a0c1db7a6600b308a78468e3459286eac55e94e8b7465b03621
MD5 b916e59ed9f9f6fd79a9571d2341f998
BLAKE2b-256 80af46c5f0c52ebe5f6ef1d2bcb4e222ca8a5f88ed6f8785ce0b663c03eab4d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.8.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 edaefa9ac226ea9afb1d14fe4b4483f5978716f058413a8edbca2eb38f97df7c
MD5 142931dd4ac9471b0a717c15c21245a6
BLAKE2b-256 2563aeb42af33f4dba318e13d03e3a37ab148f6c76377e2b1ab77d4d71e6259b

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