👋 Welcome!

New to OpenRPC? You’re in the right place. Let’s start with the big picture.

OpenRPC is an interface description for JSON-RPC. It is both human and machine-readable.

Use cases for machine-readable JSON-RPC API definition documents include, but are not limited to:

  • specification driven development
  • interactive documentation
  • code generation
    • documentation
    • clients
    • servers
  • automation of test cases

OpenRPC documents describe a JSON-RPC APIs services and are represented in JSON format. These documents may either be produced and served statically or be generated dynamically from an application.

Improve your Developer Experience

The OpenRPC created in the previous example has provided a well documented API and clients for users to interact with, and a central document for multiple stakeholders to contribute to. This opens up not only API design but the entire developer experience to a much broader audience

Right now, thousands of developers all over the world are building protocols that use JSON-RPC, and inventing new kinds of applications, many of which can benefit from OpenRPC today:

Welcome to OpenRPC.

Not sure where to go next?