Skip to content

Commit 4d9fad3

Browse files
committed
Add SDK building instructions and update mkdocs configuration
1 parent a902357 commit 4d9fad3

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Building SDK Packages
2+
3+
We use [openapi-generator](https://openapi-generator.tech/docs/generators) to create SDK packages using a spec taken directly from our C++ API
4+
5+
You can find the sdk builder, the settings, and the spec in the `sdk/` folder.
6+
7+
```shell
8+
--- SDK Generation ---
9+
make sdk Build all SDK packages
10+
make sdk android Build the android SDK package
11+
make sdk bash Build the bash SDK package
12+
make sdk cpp-oatpp-client Build the cpp-oatpp-client SDK package
13+
make sdk cpp-oatpp-server Build the cpp-oatpp-server SDK package
14+
make sdk dart Build the dart SDK package
15+
make sdk gdscript Build the gdscript SDK package
16+
make sdk go Build the go SDK package
17+
make sdk graphql-schema Build the graphql-schema SDK package
18+
make sdk haskell-http-client Build the haskell-http-client SDK package
19+
make sdk java Build the java SDK package
20+
make sdk jetbrains-http-client Build the jetbrains-http-client SDK package
21+
make sdk k6 Build the k6 SDK package
22+
make sdk lua Build the lua SDK package
23+
make sdk markdown Build the markdown SDK package
24+
make sdk mysql-schema Build the mysql-schema SDK package
25+
make sdk nim Build the nim SDK package
26+
make sdk php Build the php SDK package
27+
make sdk powershell Build the powershell SDK package
28+
make sdk protobuf-schema Build the protobuf-schema SDK package
29+
make sdk python Build the python SDK package
30+
make sdk r Build the r SDK package
31+
make sdk ruby Build the ruby SDK package
32+
make sdk rust Build the rust SDK package
33+
make sdk swift5 Build the swift5 SDK package
34+
make sdk swift6 Build the swift6 SDK package
35+
make sdk typescript Build the typescript SDK package
36+
make sdk typescript-angular Build the typescript-angular SDK package
37+
make sdk typescript-node Build the typescript-node SDK package
38+
make sdk wsdl-schema Build the wsdl-schema SDK package
39+
make sdk zapier Build the zapier SDK package
40+
```
41+
42+
```php
43+
<?php
44+
require_once(__DIR__ . '/vendor/autoload.php');
45+
46+
$blocks = new OpenAPI\Client\Api\BlockApi();
47+
48+
$hash = 'hash_example';
49+
50+
try {
51+
$block = $blocks->getBlockByHash($hash);
52+
print_r($block);
53+
print_r($block->transation_details[0]->pub_key);
54+
} catch (Exception $e) {
55+
echo 'Exception when calling BlockApi->getBlockByHash: ', $e->getMessage(), PHP_EOL;
56+
}
57+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ nav:
7373
- Developer:
7474
- getting-started/developer/index.md
7575
- getting-started/developer/build.md
76+
- getting-started/developer/sdks.md
7677
- getting-started/developer/docker.md
7778
- Updates:
7879
- updates/index.md

0 commit comments

Comments
 (0)