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!'


# 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-1.0.3.tar.gz (720.2 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.0.3-py2.py3-none-any.whl (742.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.0.3.tar.gz
Algorithm Hash digest
SHA256 693ce549fbb36f33514402f20b7e7b3dc6a210991aa06323dc7ff0c491b0ddf4
MD5 27fec7846b7b7263c4bdc770b4f08d36
BLAKE2b-256 7ad0bbed5e42017de033f783e316e82ed3446fcb3d1b36108de12561f5c2be4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 22cb160b0e32bca7ff4c890056d5eff45117341cee562724e8f66c9f4b0966f5
MD5 0e31d163823bb4bd3d65eda4fdbd908d
BLAKE2b-256 e76429a2c2e5722a1567f446334feed4a4204a0575bc44516b75c8ee49455c85

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