@open-rpc/mock-server

open-rpc-mock-server

Provides a mock JSON-RPC API with Service Discovery for a given OpenRPC document.

Install

Installing the open-rpc-mock-server in your local project.

npm install --save @open-rpc/mock-server

or install it globally

npm install -g @open-rpc/mock-server

Usage

If you installed it globally:

open-rpc-mock-server -d my-open-rpc-document.json

Optimize usage by adding script for open-rpc-mock-server in package.json.

"scripts": {
    "mock-server": "open-rpc-mock-server"
  },

The mock-server will look for an openrpc.json document in the working directory that contains a valid OpenRPC based API. Otherwise the mock-server will return an error message.

Run mock-server

npm run mock-server

The mock-server will run at http://localhost:3333/.

Sending requests

With the mock-server running at http://localhost:3333/, use Postman to send requests against the API.

Example

• Using OpenRPC Mock Server to test against an Ethereum JSON-RPC API - Jun 11, 2019 - ETC Labs Core

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.