コンテンツにスキップ

概要


Guance External API は簡素化された HTTP REST API です。

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

サポートされている Endpoint

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

API ドキュメント設定

  1. API ドキュメントの URL は固定です: \/v1/doc
    例: https://external-api.guance.com/v1/doc

  2. 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
  # アクセスキー識別子。API リクエストヘッダーの `X-Df-Access-Key` の値に対応します。空でない文字列
  accessKey: ""
  # 署名の計算に使用するシークレットキー
  secretKey: ""

現在のリポジトリ内のドラフトドキュメント

説明:テンプレート管理ドキュメントは、リリース前のドラフトとして当面 backend リポジトリ内に配置します。機能の開発が完了し、イテレーションリリース当日に正式なヘルプドキュメントのプロジェクトリポジトリへ同期します。

フィードバック

このページは役に立ちましたか?