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

Uploaded Source

Built Distribution

Flask_Restler-0.2.3-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.3.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-0.2.3.tar.gz
Algorithm Hash digest
SHA256 6fc38de2f9d6a165021101b06ee03680e53cabb8f154e3531f59f30f914f0aef
MD5 935531e24ff5b64fed5e9c363ad9e03d
BLAKE2b-256 d4860109d0e77c9bdd70d413208667687b2b146d687752dd768eafabf73b114f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0d6988aabe4b14e47a7717470350782a2ed21aa7fcb45201650710ebf5600fa
MD5 158a2e391c5cefefbbbe4f86759b55ce
BLAKE2b-256 19632a45db04120a5d9127168fdce2248cd333a1a3bf50964e91eed70623a88a

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