Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
cfn
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

open-rpc-mock-server

CircleCI branch Dependabot status npm GitHub release GitHub commits since latest release

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

Need help or have a question? Join us on Discord!

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

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.