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 and Peewee ORM.

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

Uploaded Source

Built Distribution

Flask_Restler-0.4.0-py2.py3-none-any.whl (741.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4c165e4505f0a46b4fb7709b6e09af06ad097ac04a58797b8cf96d743909ef90
MD5 1957e90eed23ce4f310bc6ea02ac8416
BLAKE2b-256 c686ac7d02b615715f1fe1305d8217ed48661751434e773bd4016312712d847b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d3ee27d6dcbeaf25bcd0ed8aa9971d20eb9d68d37ecec599b669c3583bf924b2
MD5 cbd936c9fa453a65f2ba6dc52a09d280
BLAKE2b-256 4b4f9d47c1feab888f740b2dabe105f7dbfa3947c55efceaed51f05953bd2594

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