Execution Context
この機能は、開発者向けに特化した、包括的でインタラクティブなAPIドキュメントを自動生成します。コンピューティングリソースからスキーマ定義を抽出し、自己完結型のガイドを作成することで、SDKの導入を加速し、エンドポイント仕様、認証フロー、エラー処理プロトコルへの即時アクセスを提供し、サポートチケットの削減に貢献します。
システムは、リアルタイムのコンピューティングメタデータとOpenAPIスキーマを収集し、それらを用いてドキュメントを動的に生成します。
インタラクティブな検索機能とコード生成機能が組み込まれており、開発者はドキュメント内で直接APIエンドポイントをテストすることができます。
自動検証により、生成されるすべてのコンテンツが、基盤となるコンピューティングインフラストラクチャの変更と常に同期されることを保証します。
Operating Checklist
バックエンドから、コンピューティングリソースのスキーマとエンドポイント定義を取得します。
構文ハイライト付きのコードサンプルを含む、インタラクティブなドキュメントページを生成します。
生成されたコンテンツの正確性を検証するために、ライブAPIからの応答と比較します。
更新されたドキュメントを開発者向けポータルに公開し、ユーザーに通知します。
Integration Surfaces
ドキュメントポータル
開発者がAPI仕様書やインタラクティブなサンプルにアクセスできる、集中管理されたプラットフォーム。
開発者コンソール
ドキュメント化されたエンドポイントを即時に実行できる統合テスト環境。
メール通知
開発者に対して、スキーマの変更や廃止に関する情報を自動的に通知する機能。
