{"id":21336827,"url":"https://github.com/dan-da/bisq-api","last_synced_at":"2025-03-16T02:12:12.520Z","repository":{"id":56961661,"uuid":"87663067","full_name":"dan-da/bisq-api","owner":"dan-da","description":"API docs and unit tests for bisq/bitsquare.","archived":false,"fork":false,"pushed_at":"2017-04-08T21:29:51.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-22T14:43:31.139Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dan-da.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-08T20:43:56.000Z","updated_at":"2017-04-08T20:47:21.000Z","dependencies_parsed_at":"2022-08-21T10:20:36.498Z","dependency_job_id":null,"html_url":"https://github.com/dan-da/bisq-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-da%2Fbisq-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-da%2Fbisq-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-da%2Fbisq-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dan-da%2Fbisq-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dan-da","download_url":"https://codeload.github.com/dan-da/bisq-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814893,"owners_count":20352038,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T23:55:32.444Z","updated_at":"2025-03-16T02:12:12.503Z","avatar_url":"https://github.com/dan-da.png","language":"PHP","readme":"bisq-api\n========\n\nThis repository contains files pertaining to bisq APIs.\n\nIn particular the areas of:\n* specification\n* documentation\n* schema validation\n* unit testing\n\n## Installation\n\n### composer is required.\n\nOn Ubuntu 16.04:\n\n    sudo apt install composer\n \nOn Ubuntu 14.04\n\n    curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer\n \nAnything else, visit http://getcomposer.com.\n\n### now let's get to it! \n\n    $ git clone https://github.com/dan-da/bisq-api.git\n    $ cd bisq-api\n    $ composer install\n \n## Building Docs\n\n```\n$ ./build-api-docs.sh \nAPI Docs are in apis/index.html and apis/README.md\n```\n\nAlso, docs are viewable online at:\nhttps://rawgit.com/dan-da/bisq-api/master/apis/index.html\n\n\n## Running unit tests\n\nThe tests run against a running bisq (bitsquare) instance.\n\nAt the time of this writing, API support is only available in bisq on\ndevelopment branch issue544-api.  So it is necessary to checkout and\nbuild that branch first.  When you have done this, then you need to\nstart bitsquare and ensure that it is listening on port 8080.\n\nYou can verify that bitsquare API support is working by loading this url in a\nbrowser:\n http://localhost:8080/apis/currency_list\n\nOnce that is working, proceed to run unit tests as follows:\n\n```\n$ ./run-api-tests.sh \n _____ ___  ___ _____ ___  ___\n|_   _/ __)( __/_   _/ __)| _ )\n  |_| \\___ /___) |_| \\___ |_|_\\  v1.7.1\n\nPHP 7.0.15-0ubuntu0.16.04.4 | '/usr/bin/php' -c '/tmp/.php.ini' | 8 threads\n\n...\n\n\nOK (3 tests, 0.1 seconds)\n```\n\n## Directory layout\n\n/                       project root.  contains shell scripts to perform actions.\n    apis/               api root\n        lib/            some common files\n        \u003capi\u003e           each api has its own directory with apidoc, schema, and unit test files.\n    vendor/             built automatically by composer.\n        \n\n## Docs build system\n\nDocumentation for each api is contained in /apis/\\\u003capi\u003e/apidoc.php in a\nstructured data format without any display markup.\n\nThe build-api-docs.sh script processes each API directory and generates documentation\nin both HTML and markdown formats. In the future it could be extended to\ngenerated PDF or anything else.\n\n## JSON Schema for API responses\n\nAPI responses contain complex structured data that is difficult to validate\nmanually.\n\nAs such, a json schema is created for each API response, located in\n/apis/\\\u003capi\u003e/schema.json.\n\nInitially, these schemas are created automagically by providing a sample JSON\nresponse to this tool:\n\nhttps://jsonschema.net/#/editor\n \nFurther manual editing of the schemas may be desirable as we go forward.\n\nThe unit tests for each API perform an API call and then validate the response\nagainst the schema. Any validation error will cause the test to fail and the\nerrors are reported.\n\n## API Versioning.\n\nThe API will be versioned according to the bitsquare release version.\n\nThere is no separate versioning.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdan-da%2Fbisq-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdan-da%2Fbisq-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdan-da%2Fbisq-api/lists"}