コンテンツにスキップ

概要¶

Guance External API は、シンプルな HTTP REST API です。

GET / POST リクエストのみ
リソース指向の URL を使用した API 呼び出し
ステータスコードによるリクエストの成功/失敗の通知
すべてのリクエストは JSON 構造を返却
External API はプログラマティックに Guance プラットフォームを管理します

サポートされる Endpoint¶

デプロイタイプ	ノード名	Endpoint
プライベートデプロイメント版	プライベートデプロイメント版	実際にデプロイされた Endpoint に準拠します。通常は https://external-api.guance.com

API ドキュメント設定¶

インターフェースドキュメントのアドレスは固定で、\/v1/doc です。
例: https://external-api.guance.com/v1/doc

API ドキュメントのスイッチ設定は、launcher 内の core (名前空間: forethought-core) 設定にあります。具体的な設定は以下の通りです。

# API Doc
apiDocPageSwitch:
  # external api インターフェースドキュメントページのスイッチ。true: 有効; false: 無効。デフォルトは `false`
  external: true

サービス設定項目¶

オプションの設定項目は、launcher 内の core (名前空間: forethought-core) 設定にあります。具体的なオプション設定は以下の通りです。

# external-api サービスの設定項目
external:
  # リクエスト署名の有効期間（秒）。デフォルトは 60秒
  timeliness: 60
  # 訪問者識別子。インターフェースリクエストヘッダーの `X-Df-Access-Key` 値に対応。空でない文字列
  accessKey: ""
  # 署名計算に使用するシークレットキー
  secretKey: ""

現在のリポジトリ内の下書きドキュメント¶

テンプレート管理

説明: テンプレート管理ドキュメントは、現時点では backend リポジトリ内に、リリース前の下書きとして配置されています。機能が完全に開発され、イテレーションでリリースされた当日に、正式なヘルプドキュメントプロジェクトリポジトリに同期されます。