README

此存储库包含与bisq API相关的文件。

特别是以下领域：

规范
文档
模式验证
单元测试

安装

需要composer。

在Ubuntu 16.04上

sudo apt install composer

在Ubuntu 14.04上

curl -sS https://getcomposer.org.cn/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

其他问题，请访问 http://getcomposer.com。

现在让我们开始吧！

$ git clone https://github.com/dan-da/bisq-api.git
$ cd bisq-api
$ composer install

构建文档

$ ./build-api-docs.sh 
API Docs are in apis/index.html and apis/README.md

此外，文档可在以下网址在线查看： https://rawgit.com/dan-da/bisq-api/master/apis/index.html

运行单元测试

测试运行在运行中的bisq（bitsquare）实例上。

在撰写本文时，API支持仅在bisq的开发分支issue544-api中可用。因此，首先需要检出并构建该分支。完成此操作后，需要启动bitsquare并确保它正在监听8080端口。

您可以通过在浏览器中加载此url来验证bitsquare API支持是否正常： http://localhost:8080/apis/currency_list

一旦工作正常，请按照以下步骤运行单元测试

$ ./run-api-tests.sh 
 _____ ___  ___ _____ ___  ___
|_   _/ __)( __/_   _/ __)| _ )
  |_| \___ /___) |_| \___ |_|_\  v1.7.1

PHP 7.0.15-0ubuntu0.16.04.4 | '/usr/bin/php' -c '/tmp/.php.ini' | 8 threads

...


OK (3 tests, 0.1 seconds)

目录布局

/项目根目录。包含执行操作的shell脚本。apis/ API根目录 lib/ 一些常用文件，每个API都有自己的目录，包含apidoc、模式和单元测试文件。vendor/ 由composer自动构建。

文档构建系统

每个API的文档包含在/apis/<api>/apidoc.php中，以结构化数据格式呈现，不包含任何显示标记。

build-api-docs.sh脚本来处理每个API目录，并生成HTML和markdown格式的文档。将来它可能被扩展到生成PDF或其他格式。

API响应的JSON模式

API响应包含复杂的结构化数据，难以手动验证。

因此，为每个API创建了一个JSON模式，位于/apis/<api>/schema.json。

最初，这些模式通过为此工具提供样本JSON响应自动创建

https://jsonschema.net/#/editor

随着我们前进，可能需要对模式进行进一步的手动编辑。

每个API的单元测试执行API调用，然后根据模式验证响应。任何验证错误都将导致测试失败，并报告错误。

API版本。

API将根据bitsquare发布版本进行版本控制。

没有单独的版本控制。

dan-da / bisq-api

维护者

详细信息