https://github.com/mon4ter/sanic-jsonrpc

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket
https://github.com/mon4ter/sanic-jsonrpc

jsonrpc sanic websocket

Last synced: 3 months ago
JSON representation

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket

• Host: GitHub
• URL: https://github.com/mon4ter/sanic-jsonrpc
• Owner: mon4ter
• License: mit
• Created: 2019-07-06T07:00:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-25T20:44:43.000Z (about 3 years ago)
• Last Synced: 2024-09-23T21:21:40.539Z (5 months ago)
• Topics: jsonrpc, sanic, websocket
• Language: Python
• Size: 204 KB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sanic-jsonrpc

[![PyPI version](https://img.shields.io/pypi/v/sanic-jsonrpc.svg)](https://pypi.org/project/sanic-jsonrpc)

[![Python version](https://img.shields.io/pypi/pyversions/sanic-jsonrpc.svg)](https://pypi.org/project/sanic-jsonrpc)

[![Build Status](https://travis-ci.org/mon4ter/sanic-jsonrpc.svg?branch=master)](https://travis-ci.org/mon4ter/sanic-jsonrpc)

[![codecov](https://codecov.io/gh/mon4ter/sanic-jsonrpc/branch/master/graph/badge.svg)](https://codecov.io/gh/mon4ter/sanic-jsonrpc)

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket

## Features

* Complete JSON-RPC 2.0 Specification implementation, including [batch](https://www.jsonrpc.org/specification#batch)

* Annotation based type validation

* Request and/or Notification routing

* Conditional middleware

* Exception handlers

* Server side Notifications

* Access to app and request objects via annotation

## Example

### server.py

```python

from sanic import Sanic

from sanic_jsonrpc import SanicJsonrpc

app = Sanic('server')

jsonrpc = SanicJsonrpc(app, post_route='/api/rpc/post', ws_route='/api/rpc/ws')

@jsonrpc

def sub(a: int, b: int) -> int:

    return a - b

if __name__ == '__main__':

    app.run(host='127.0.0.1', port=8000)

```

### client.py

```python

from asyncio import get_event_loop

from aiohttp import ClientSession

async def main():

    url = 'http://127.0.0.1:8000/api/rpc'

    request = {'jsonrpc': '2.0', 'method': 'sub', 'params': [42, 23], 'id': 1}

    async with ClientSession() as session:

        async with session.post(url + '/post', json=request) as resp:

            response = await resp.json()

            print(response['result'])  # 19

        async with session.ws_connect(url + '/ws') as ws:

            await ws.send_json(request)

            response = await ws.receive_json()

            print(response['result'])  # 19

if __name__ == '__main__':

    get_event_loop().run_until_complete(main())

```