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

Uploaded Source

Built Distribution

Flask_Restler-1.19.1-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.19.1.tar.gz
Algorithm Hash digest
SHA256 7b51320d9c096405c40ddc70aef2f00dcf17153a28cfe76e0cdac1a8f6f8c8ab
MD5 78d76ccce5977e208cf83ac35ad4e6bd
BLAKE2b-256 92194dc839a78873c7fecefb0abe908b549bf2f5600dc0044098ce20ed74bea0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.19.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 20f70ad93ed2b20a30ef0c32723471cde1512716565bb55db50873d00ad5dce7
MD5 2a21014a168aa03ec6639dd47f596516
BLAKE2b-256 d1b3f02e1cc26eeaa629bb255ce012477ce92f3d3b6167cf80ce8c0a49e45f93

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