Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 2.42 KB

README.md

File metadata and controls

35 lines (28 loc) · 2.42 KB
Raw

Bisq API Reference Doc Generator

Generates content for the Bisq API Reference site.

What is bisq-api-reference?

This project's main purpose is to generate the Markdown text for the API Reference. It also provides a Java and Python workarea for running API client example code, and developing new Java and Python clients and bots.

It contains four subprojects:

  1. reference-doc-builder -- The Java application that produces the API Reference content, from Bisq protobuf definition files.
  2. cli-examples -- A folder of bash scripts demonstrating how to run API CLI commands. Each script is named for the RPC method call being demonstrated.
  3. java-examples -- A Java project demonstrating how to call the API from Java gRPC clients. Each class in the bisq.rpccalls package is named for the RPC method call being demonstrated. There are also some mainnet-ready Java API bots in the bisq.bots package.
  4. python-examples -- A Python3 project demonstrating how to call the API from Python3 gRPC clients. Each class in the bisq.rpccalls package is named for the RPC method call being demonstrated. There are also some simple (not-ready-for-mainnet) bot examples in the bisq.bots package.

The RPC method examples are also displayed in the API Reference. While navigating the RPC method links in the reference's table of contents on the left side of the page, they appear in the dark, right side of the page. There is also a copy-to-clipboard icon at the top right of each example.

More details about the subprojects can be found in each subproject's README.