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

Uploaded Source

Built Distribution

Flask_Restler-1.2.4-py2.py3-none-any.whl (743.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.2.4.tar.gz
Algorithm Hash digest
SHA256 0bbc422046d578058e4a19c5725b8843dfeddef31afc986be74b0dbd907e2fc2
MD5 1ead62d6e007e4e3c042ebd862d7f92d
BLAKE2b-256 084891825f5aec301186fd2d7284d479a0f065cc31faf1bcdd164ca1ae1d46e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdb34bab5cacdb1152153e1eb6c5d664632da9b4ae663aed5d8098a8d9ffbd8f
MD5 610600168831affe3d80c87a4ba7fbde
BLAKE2b-256 d6275936a66f8a2c53619a8e08a71dca27ccc19a924e990881c8b2f5ac390c32

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