Octane API Client

OctaneのAPIサーバとの通信を仲介し、後続のクライアント実装へ提供するための中間ライブラリ。

APIとの煩雑なやりとりを隠蔽し、クライアント実装に必要な機能を提供することを目的に作られた。

例えばAPIの制約上必要である30分に一回のヘルスチェックや連続して呼ぶ必要のあるAPIリクエストを自動的に呼び出すなどの機能を持つ。

APIリファレンス

ドキュメントはこちら。信頼と実績のDoxygen製。

ビルド&テスト方法

各環境向けにスクリプト書いたのでそれ使ってください。

• cmd
• PowerShell
• bashなど

Git Submoduleでの使い方

gitにsubmoduleを追加する。

git submodule add https://github.com/Team-Kamo/api-client.git

ルートのCMakeLists.txtに次の項目を追加する。

include_directories(${CMAKE_CURRENT_SOURCE_DIR}/api-client/src/include)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/api-client)

ライブラリを使用するターゲットにoctane_api_clientを追加する

target_link_libraries(your_target [PUBLIC, PRIVATE, INTERFACE] octane_api_client)