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

Uploaded Source

Built Distribution

Flask_Restler-1.2.5-py2.py3-none-any.whl (743.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.2.5.tar.gz
Algorithm Hash digest
SHA256 7b4f1a00289db3e4ffd84e065f7642931a5bf8237417b25f8b4ada568581dec2
MD5 498b79d70cda13ac12dbfe31a073700a
BLAKE2b-256 c72c8bf18cb9b69479c6efe8a8e67dd4d9d957ebb9185cbfde13cce04d92098e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 26b74e6cb1039ea49f68a29dfcb213fd8706baa09351f5c0b0c5d32204170f29
MD5 d811ff67fd552aafc5623b4b8ae2b185
BLAKE2b-256 23442143469edc9ad0648f39a4f1c64eecc154a771b0c3f60b27b9146e44ed48

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