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

This version

1.7.0

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

Uploaded Source

Built Distribution

Flask_Restler-1.7.0-py2.py3-none-any.whl (744.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.0.tar.gz
Algorithm Hash digest
SHA256 b1ba3d028f2242b33ee80ef26276278548179eb767bd14d9c1207b05fda239e2
MD5 df7543ea3b4a78a8ba9c1aa71aab3fd5
BLAKE2b-256 d3c15403e80b6d66ac99b4025d9d4f809c0cfffca3d5c8ad445389cbcb08a363

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 91cab7f2c87b01ab0cb1bd61344f37ffffd0a644f84f0514c92e30c434e3ce81
MD5 4f76bedd6816e8d3f4d15e905f2bb931
BLAKE2b-256 55863764da3227ebf42f22c602bc3252b776bc1f66c64b3d9095fc94b091f008

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