JSON RPC Documentation Tool
Asked Answered
W

2

7

Are there any Documentation Tools for JSON RPC API's? I found a lot which are perfect for RESTful API's (Slate, Spotlight, Swagger) but sadly none suitable for JSON RPC API's.

Ideal would be a Tool that can handle both.

Are there any?

Thanks a lot!

Winker answered 15/10, 2018 at 8:52 Comment(1)
I found Slate to be ok for the Job - It's Opensource and produces static API Docs. github.com/lord/slateZeba
H
5

Found a couple:

Looking at using jrgen for my project.

Homeopathic answered 11/12, 2019 at 23:54 Comment(0)
P
1

Check this one: https://jsight.io

JSight has HTTP REST and also JSON-RPC 2.0 support, look here for details: https://jsight.io/docs/jsight-api-0-3-quick-tutorial

This is the JSON-RPC definition example from the site:

JSIGHT 0.3

URL /api/rpc
  Protocol json-rpc-2.0

  Method createCat // Create a cat.
    Params
      {
        "cat": @cat
      }
    Result
      {
        "id": 1 // Cat’s id.
      }

  Method getCat // // Get a cat by its id.
    Params
      {
        "id": 1 // Cat’s id.
      }
    Result
      @cat

TYPE @cat
{
  "id": 1,
  "name": "Tom"
}

The same example in the cloud: https://editor.jsight.io/r/qjxRR6a/1

Proconsul answered 16/2, 2023 at 20:0 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.