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

Uploaded Source

Built Distribution

Flask_Restler-1.6.4-py2.py3-none-any.whl (744.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.6.4.tar.gz
Algorithm Hash digest
SHA256 b11329f0e5754a69c36723402ae700915f36243bf6c375cbf81998101085a50e
MD5 fe838ad64ecc0020d528e833d80488b4
BLAKE2b-256 59a8969ce304d46c6c78e08efa461d711fcb494693f9ce0a30a55d3d26213d68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.6.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 644778f74035f23566c7d74a907ed6284475d9f21bc653a65dfacabfdcc17f29
MD5 ed2a4c3178cb0bc65a57d5a1dea37978
BLAKE2b-256 46e0451aeec7b5724b13f12cb7b99a69bba6649cec0788bc9f0dd18414d09193

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