mirror of
https://github.com/bisq-network/bisq-api-reference.git
synced 2026-08-04 00:49:21 +00:00
b0b6c9c771
- When bot is run from a *nix terminal, password input will not be echoed. - When bot is run from an IDE, it's virtual terminal will echo the input (cannot be avoided). Validate the input during startup, to fail early instead of waiting for the right offer to take, then failing to unlock the wallet with an incorrect password.
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:
- reference-doc-builder -- The Java application that produces the API Reference content, from Bisq protobuf definition files.
- 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.
- 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.
- 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 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.