Flask JSON-RPC

A basic JSON-RPC implementation for your Flask-powered sites.

Some reasons you might want to use:

• Simple, powerful, flexible and pythonic API.
• Support python 3.6 or later.
• The web browsable API.
• Run-time type checking functions defined with PEP 484 <https://www.python.org/dev/peps/pep-0484/>_ argument (and return) type annotations.
• Extensive documentation, and great community support.

There is a live example API for testing purposes, available here <http://flask-jsonrpc.herokuapp.com/api/browse>_.

Below: Screenshot from the browsable API

.. image:: https://f.cloud.github.com/assets/298350/1575590/203c595a-5150-11e3-99a0-4a6fd9bcbe52.png

Adding Flask JSON-RPC to your application

1. Installation

    $ pip install Flask-JSONRPC

or

    $ git clone git://github.com/cenobites/flask-jsonrpc.git
    $ cd flask-jsonrpc
    $ python setup.py install

2. Getting Started

Create your application and initialize the Flask-JSONRPC.

    from flask import Flask
    from flask_jsonrpc import JSONRPC

    app = Flask(__name__)
    jsonrpc = JSONRPC(app, '/api')

Write JSON-RPC methods.

    @jsonrpc.method('App.index')
    def index() -> str:
        return 'Welcome to Flask JSON-RPC'

All code of example run.py <https://github.com/cenobites/flask-jsonrpc/blob/master/run.py>_.

3. Running

    $ python run.py
     * Running on http://0.0.0.0:5000/

4. Testing

    $ curl -i -X POST \
       -H "Content-Type: application/json; indent=4" \
       -d '{
        "jsonrpc": "2.0",
        "method": "App.index",
        "params": {},
        "id": "1"
    }' http://localhost:5000/api
    HTTP/1.0 200 OK
    Content-Type: application/json
    Content-Length: 77
    Server: Werkzeug/0.8.3 Python/2.7.3
    Date: Fri, 14 Dec 2012 19:26:56 GMT

    {
      "jsonrpc": "2.0",
      "id": "1",
      "result": "Welcome to Flask JSON-RPC"
    }

References

• http://docs.python.org/
• https://flask.palletsprojects.com/
• http://www.jsonrpc.org/