qiwi/json-rpc

Tools, utils and helpers for JSON RPC 2.0 integration

@qiwi/json-rpc

Tools, utils and helpers for JSON RPC 2.0 integration.

• nestjs-json-rpc
• expressjs-json-rpc

Status

🚧 Work in progress 🚧 / Experimental / Early preview / pre-alpha version / 0.0.0-draft

Usage

With Nestjs:

import {
  JsonRpcController,
  JsonRpcMethod,
  IJsonRpcId,
  IJsonRpcParams
} from 'nestjs-json-rpc'

@JsonRpcController('/jsonrpc/endpoint')
export class SomeJsonRpcController {
  @JsonRpcMethod('some-method')
  doSomething(@JsonRpcId() id: IJsonRpcId, @JsonRpcParams() params: IJsonRpcParams) {
    const {foo} = params
    
    if (foo === 'bar') {
      return new JsonRpcError(-100, '"foo" param should not be equal "bar"')
    }
    
    return 'ok'
  }
}

// App.ts
@Module({
  imports: [...],
  controllers: [SomeJsonRpcController],
  providers: [...],
})
export class AppModule {}

With Express:

import {
  JsonRpcMiddleware,
  JsonRpcMethod,
  IJsonRpcId,
  IJsonRpcParams
} from 'expressjs-json-rpc'

@JsonRpcMiddleware()
export class SomeJsonRpcMware {
  @JsonRpcMethod('some-method')
  doSomething(@JsonRpcId() id: IJsonRpcId, @JsonRpcParams() params: IJsonRpcParams) {
    const {foo} = params
    
    if (foo === 'bar') {
      return new JsonRpcError(-100, '"foo" param should not be equal "bar"')
    }
    
    return 'ok'
  }
} 

const jsonRpcMware = new SomeJsonRpcMware().middleware

app.use('/rpc', jsonRpcMware)

Specification

https://www.jsonrpc.org/specification

License

MIT