Skip to content

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket

License

Notifications You must be signed in to change notification settings

mon4ter/sanic-jsonrpc

Repository files navigation

sanic-jsonrpc

PyPI version Python version Build Status codecov

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket

Features

  • Complete JSON-RPC 2.0 Specification implementation, including 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

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

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())

About

JSON-RPC 2.0 support for Sanic over HTTP and WebSocket

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages