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

Uploaded Source

Built Distribution

Flask_Restler-1.19.3-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.19.3.tar.gz
Algorithm Hash digest
SHA256 cd2b6ff6a3247d5e93fcb27af0f4ac8cb148c7c85ed64e35d363363c8ba209b1
MD5 13c70aea2306ffa137ba24c966db5046
BLAKE2b-256 28e226cbf39c43f792f1741a81572235af70cf5293b7033cdc3346f44e1da40d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.19.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6542ebb97d38fd28e8829c4380acd4b47f7844e7052f596e529d16b52eb9eeda
MD5 c3909bd150ff2fe853d061e987b69afb
BLAKE2b-256 26b99a64f3f71d76c2031a10d42df8d9d466d00077fb48b06f799a3ad9260e1d

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