Adds JSONRPC support to Flask.
Project description
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 JSON-RPC 2.0 version.
- Support python 3.6 or later.
- The web browsable API.
- Run-time type checking functions defined with PEP 484 argument (and return) type annotations.
- Extensive documentation, and great community support.
There is a live example API for testing purposes, available here.
Below: Screenshot from the browsable API
Adding Flask JSON-RPC to your application
- Installation
$ pip install Flask-JSONRPC
or
$ git clone git://github.com/cenobites/flask-jsonrpc.git
$ cd flask-jsonrpc
$ python setup.py install
- 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', enable_web_browsable_api=True)
Write JSON-RPC methods.
@jsonrpc.method('App.index')
def index() -> str:
return 'Welcome to Flask JSON-RPC'
All code of example run.py.
- Running
$ python run.py
* Running on http://0.0.0.0:5000/
- 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
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-JSONRPC-1.1.1.tar.gz
(690.5 kB
view hashes)
Built Distribution
Flask_JSONRPC-1.1.1-py3-none-any.whl
(719.1 kB
view hashes)
Close
Hashes for Flask_JSONRPC-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2af6e4c6c4f08d65c9fcab9e84ead91d17ba48ee8ea8c0eae0884a2f521e415b |
|
MD5 | 7d29d64fc655ba435b1c402ddf7d7d91 |
|
BLAKE2b-256 | 0c24168feada62d6089c72ba6039c36664356ff8f892a3b5cba20362851f1f46 |