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

Uploaded Source

Built Distribution

Flask_Restler-1.19.4-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.4.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.19.4.tar.gz
Algorithm Hash digest
SHA256 e522ba77a224f19c2ef7c7600022f19c40fbc112f14f5d08898a78e3f22f20b8
MD5 1fe7fb5336984906e8ef7982ca506778
BLAKE2b-256 6386752a97a9c5106968c2745a4f0ca81b48006adcc77cda9eb07abe25c48f6d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.19.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 90d6b7e1103847222b3d1848444e94359979fff64ece8e8f5e79c95f1c200fc5
MD5 9b17250b916485738a8889f3912fe6ff
BLAKE2b-256 ad57bfb08df78b01b1dbbc649c2995e2e71b6206f1689928877706df868701a0

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