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!'


# Regiater 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.1.0.tar.gz (720.3 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.1.0-py2.py3-none-any.whl (743.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a97edb88f76bd806d127d29378a0ed2cc7e8a210b0ffe1cfe41c877cf59f1cee
MD5 76c50791a5c639543e8d0d00378c4542
BLAKE2b-256 b149fd615b71cf7869c7232de8cabbb3847335a971d433d8b3e6c1b0141620cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b4dc4e749c9901b82fe80c017d807a769505be35e69969f025ed53bab0c22209
MD5 fd4765d101735447aad85397f4b60bc7
BLAKE2b-256 820a8c4247c01e574dc0688c3c1c6384e1d8986eb580efde125f28af5410f546

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