Feature Request / Question: JSONRPC2

[joeblew99]

this is not a bug, but a question.

Is there currently a way to code gen a JSONRPC2 client from swagger ?
i am interested in the Dart client.

thanks in advance, or if i should ask this somewhere else please let me know.

[wing328]

Not that I'm aware of but you can always customize the templates for Dart and pass it via the -t option.

[cbornet]

Swagger can certainly describe the outer structure of JSON-RPC (id, method, params fields, etc...) but I think it will be hard to describe the methods themselves since they are described in body objects ("SOAP" style) where swagger is oriented towards path objects ("REST" style). For instance it will be hard to link a method request (which would be a model) to its corresponding method result (another model).

[joeblew99]

@cbornet i see what you mean. Basically, if i get this, denormalisation of the structure between REST and RPC is just too different and so reconstruction is just too much work. In other words it is not the right approach.

I actually want to have a REST / JSON API and a JSONRPC2 API running at the gateway level
Both of which map to the GRPC service behind the gateway.

I was looking at the GRPC code and the JSONRPC2 code and they are almost identical in many ways. SO i am not thinking that code generating from GRPC to JSONRPC2 should have nothing to do with swagger. I need to find / write a code gen just for this.

Let me knwo what you think if you get time.

[ppKrauss]

Hi @cbornet , perhaps "JSONRPC2 envelope" is a good suggestion to add into OpenAPI v3...
The envelope is a simple discipline and way to standardize asynchronous request-ID, versions, etc. at input params, and error messages, etc. at output result. How to suggest it there?

Perhaps changes to flexiblize a little bit the params envelop structure, OpenAPI also will create the JSONRPC v3 :-)

---

PS: for general. I think there are no conflict between REST and "JSON RPC envelope", JsonRPC-REST exist, and is like to old SOAP-REST.

[wing328]

@joeblew99 please join the discussion in the Swagger Spec repo: OAI/OpenAPI-Specification#664