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

This version

0.3.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-0.3.0.tar.gz (718.9 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-0.3.0-py2.py3-none-any.whl (740.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6a217045e16f217a40f98e7b68698608b1c210dab79c7b921ec7af2de9a67015
MD5 46d0ca879e000dee29b19e704d983a47
BLAKE2b-256 128d1e68c96edeaf885717b67a719622907028dd75967dba15bb16b39338fa92

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 99f388edd364495f14d52c724d3f652bb0c50ee020adc6b2e3b34e0cb207df5b
MD5 062f299476a5b84771dc7c6e2fac6eb9
BLAKE2b-256 4d8861c67be083fcce7753353d906f4b97c7fc19cd89fa0abb5f5481f43d4e5e

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