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

Uploaded Source

Built Distribution

Flask_Restler-1.4.5-py2.py3-none-any.whl (743.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.4.5.tar.gz
Algorithm Hash digest
SHA256 35db2058d52091349fef87623194176bd7a171fbf01bd7b7114c43c5baaa617d
MD5 2fe18ee39d82d3c7ba425d7dabb1c107
BLAKE2b-256 c0765c803238001cd9fb74643fa5bf1d4d1d19db2bfa907d0b9be1890da4db08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.4.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bc8f37b8565172e50b78633ba31c36f5f72bc648fcd84f5c5ab586dd65816da9
MD5 d17da9cf350abeecf5f6f45036b39806
BLAKE2b-256 25d4f70da27d8b9e5dac5b7266b99c0c1a4fc033b4acb02c707e2c60c4556307

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