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

Uploaded Source

Built Distribution

Flask_Restler-1.10.1-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.1.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.10.1.tar.gz
Algorithm Hash digest
SHA256 cd52e6a944596d996ccce84922161e3d5cb6f6e3ad1763bf616fd62726d637eb
MD5 c777997059ff46495ef7feac89c55e76
BLAKE2b-256 2cd0605cd9ebf7e46bf5537189b2d9ac4f7ee418cf954500f346b63ac3eb6662

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 27d35ebbef9cb4862870febfcd34d9c79dc8325596f62c72b4109c19c9d83f0c
MD5 a96e275b8587be5a2158c7fcf8f4b21c
BLAKE2b-256 634058685c671ba6caca3c5e9510446435a16fef014a5af8000d9c68a35382f3

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