Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 3.09 KB

FAQ.md

File metadata and controls

60 lines (46 loc) · 3.09 KB

Are there assets I can use to talk about OpenRPC?

open-rpc/design houses all the design assets for OpenRPC

openrpc-spec-structure openrpc-logo

Why should I use OpenRPC to describe my JSON-RPC API?

OpenRPC documents are both machine and human readable and clearly define your API. Use cases for machine-readable JSON-RPC API definition documents include, but are not limited to:

  • interactive documentation
  • code generation for documentation
  • clients
  • servers
  • mock servers
  • automation of test cases
  • improve maintainability
  • reduce code and mistakes
  • parallel teams building of client/server based on the agreed spec

Why JSON-RPC?

REST is pretty ambiguous. It is unlikely that any two developers will produce the same REST API. JSON-RPC is a serious contender for services because it is simple, JSON based, and protocol agnostic.

There is a growing need for a standard way to describe the critical open source infrastructure that depends on it.

Is there anywhere I can try OpenRPC?

Yes, you can experiment with OpenRPC using our Playground tool. There are pre-built examples in playground that can be used for learning and reference.

What uses JSON-RPC in the wild?

Is the specification available in languages other than English?

Currently the specification does not support any languages other than English. However, we are considering possible solutions to the situation. If you wish to follow or contribute to the discussion it can be found here.