https://github.com/cenobites/flask-jsonrpc
Basic JSON-RPC implementation for your Flask-powered sites
https://github.com/cenobites/flask-jsonrpc
flask flask-extensions jsonrpc python
Last synced: 1 day ago
JSON representation
Basic JSON-RPC implementation for your Flask-powered sites
- Host: GitHub
- URL: https://github.com/cenobites/flask-jsonrpc
- Owner: cenobites
- License: bsd-3-clause
- Created: 2012-12-14T18:33:24.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-02-01T07:56:55.000Z (2 months ago)
- Last Synced: 2025-04-14T01:07:26.099Z (1 day ago)
- Topics: flask, flask-extensions, jsonrpc, python
- Language: Python
- Homepage:
- Size: 1.94 MB
- Stars: 290
- Watchers: 13
- Forks: 62
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-flask - flask-jsonrpc - A basic JSON-RPC implementation for your Flask-powered sites (Utils)
- awesome-flask - flask-jsonrpc - A basic JSON-RPC implementation for your Flask-powered sites (Utils)
- awesome-flask - flask-jsonrpc - A basic JSON-RPC implementation for your Flask-powered sites (Utils)
- jimsghstars - cenobites/flask-jsonrpc - Basic JSON-RPC implementation for your Flask-powered sites (Python)
- best-of-web-python - GitHub - 13% open · ⏱️ 06.05.2024): (Flask Utilities)
README
[](https://coveralls.io/github/cenobites/flask-jsonrpc?branch=master)
[](https://flask-jsonrpc.readthedocs.io/en/latest/?badge=latest)
# Flask JSON-RPC
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](https://www.jsonrpc.org/specification "JSON-RPC 2.0") version.
* Support Python 3.9 or later.
* Experimental support to [Mypyc](https://mypyc.readthedocs.io/en/latest/introduction.html), it compiles Python modules to C extensions.
* The web browsable API.
* Run-time type checking functions defined with [PEP 484](https://www.python.org/dev/peps/pep-0484/ "PEP 484") argument (and return) type annotations.
* Extensive documentation, and great community support.
There is a live example API for testing purposes, [available here](https://flask-jsonrpc.cenobit.es/api/browse/#/ "Web browsable API").
**Below:** *Screenshot from the browsable API*
### Adding Flask JSON-RPC to your application
1. Installation
```console
$ pip install Flask-JSONRPC
```
or
```console
$ 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.
```python
from flask import Flask
from flask_jsonrpc import JSONRPC
app = Flask("application")
jsonrpc = JSONRPC(app, "/api", enable_web_browsable_api=True)
```
Write JSON-RPC methods.
```python
@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
```console
$ python run.py
* Running on http://0.0.0.0:5000/
```
4. Testing
```console
$ 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/](http://docs.python.org/)
* [https://flask.palletsprojects.com/](https://flask.palletsprojects.com/)
* [http://www.jsonrpc.org/](http://www.jsonrpc.org/)