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

Uploaded Source

Built Distribution

Flask_Restler-1.10.2-py2.py3-none-any.whl (465.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.10.2.tar.gz
Algorithm Hash digest
SHA256 507fa03eb445bdb419d302b2e9682994acf39c5e1d8d37b2e0fa24c0e5bbb8eb
MD5 fe145edafaecc102f378e5a2360d2e67
BLAKE2b-256 dc7fcf51823fdb76ed3f7c30116dd77bb4401f351d001302feda25cab0551f34

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.10.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fecddb440fee15c5f2d1b80d4bd9c3fde77f5101504b4215977da92c18041071
MD5 af55e84ca97722e51c54e371363aa2f9
BLAKE2b-256 ab58b23ec48bb4c1a41f5a834b25b3ece2f7054f99b759eb16c02942f7cc3125

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