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

Uploaded Source

Built Distribution

Flask_Restler-1.11.1-py2.py3-none-any.whl (466.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.11.1.tar.gz
Algorithm Hash digest
SHA256 330419cefa374830729c1dc8fcfbec66ee30cb1b4ae0d9a061a3d2bc51bad7c2
MD5 1a723a00b791f9d4226c863d4c0f10ad
BLAKE2b-256 9ba7d9ca9da8eafffc1401d65d9cfc8305f8ca8b43fdf99f524ebfd484183a72

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.11.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0ba4915df0210803ee2ae8a973e02a856193fb19b41dd35b0dc1827dbb5400a4
MD5 a983f3dcbde127c442d51d8140dd293a
BLAKE2b-256 028edaae447821811b70673d0a2bd7329edf6e0bdc64ff2a26e288737f43a647

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