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

Uploaded Source

Built Distribution

Flask_Restler-0.4.5-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.5.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-0.4.5.tar.gz
Algorithm Hash digest
SHA256 335bf658f5a17fd109b1d9c0086467cfd3542b20db7cf2115add4e7f7157c4cd
MD5 859256be280fc71a0484ddd7bde3cac6
BLAKE2b-256 69d3fcbadabd71c7e45aba3a3097646813eb0fe79837ccbbbaf9b0c57af91e16

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f40c96ab342612b4d3c7da658a0cfea69ebdd55e8e501ef9c3c7c9f4a168a7c1
MD5 0feabc9e66f78b944b924e09f5e22550
BLAKE2b-256 995da93718c09d4633e2a529e64bcb21fed666cccf27abac16cb68353c88a840

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