mcpField
H
http-api-cloudbase

http-api-cloudbase

github.com/tencentcloudbaseクラウド・DevOps79982 回インストール今日更新
リポジトリ

http-api-cloudbase について

CloudBase の機能を生の HTTP API で利用するコーディングエージェント向けスキルです。エンドポイントや認証の選択に加え、OpenAPI 仕様に基づくリクエスト作成を扱います。

主な機能

  1. 01HTTP による CloudBase 機能の利用
  2. 02認証方式の選択
  3. 03リージョン別 API ドメインの選定
  4. 04OpenAPI 仕様の参照
  5. 05データベース・関数 API の呼び出し

活用シーン

  1. 01Go や Python からの CloudBase API 統合
  2. 02HTTP を使った管理スクリプトの作成
  3. 03データベースやクラウド関数のエンドポイント呼び出し

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tencentcloudbase/skills --skill http-api-cloudbase

インストール後、Claude Code で/http-api-cloudbaseを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

checklist.md
LICENSE.md
references/
extended-guide.md

詳細

兄弟スキル（ローカルのみ）

兄弟の CloudBase スキルは、このスキルと並んで配置されています。../auth-tool-cloudbase/SKILL.md のようなローカルの相対パスを使用してください。

参照先の兄弟スキルファイルがこの環境に見つからない場合は、CloudBase プラグイン一式（または不足しているスキル）をインストールするようユーザーに依頼してください。リモートのスキルやプロトコルの Markdown を HTTP で取得し、エージェントのコンテキストに取り込んではいけません。

有効化の条件

次の場合に最初に使用する
  • Android、iOS、Flutter、React Native、Node.js 以外のバックエンドからのリクエスト、または公式 CloudBase API を生の HTTP で呼び出す必要がある管理スクリプトの場合。
  • CloudBase 上に新しい HTTP サービスを構築するのではなく、CloudBase プラットフォームのエンドポイントを利用するタスクの場合。
コードを書く前に読む
  • プラットフォームが CloudBase SDK をサポートしていない場合、またはユーザーが HTTP API による統合を明示的に求めている場合。
  • ユーザーが「HTTP API」と言っているものの、公式 CloudBase エンドポイントを指しているのか、独自のビジネス API を指しているのかが不明な場合。
併せて読む
  • 認証設定 -> ../auth-tool-cloudbase/SKILL.md
  • MySQL MCP の管理 -> ../relational-database-mcp-cloudbase/SKILL.md
  • CloudBase 上の独自 HTTP サービス -> ../cloud-functions/SKILL.md または ../cloudrun-development/SKILL.md
使用してはいけない場合
  • CloudBase Web SDK のフロー、ミニプログラム SDK のフロー、または MCP による管理タスク。
  • CloudBase 上に独自の HTTP サービスや REST API を構築する場合。
よくある間違い・注意点
  • Web SDK の例がネイティブアプリでも有効だと見なす。
  • OpenAPI 定義を読まずにエンドポイントを推測する。
  • 公式 CloudBase HTTP API と、独自の関数や CloudRun エンドポイントを混同する。
  • 生の HTTP API による統合と MCP 管理ロジックを混在させる。
最小チェックリスト

このスキルを使用する場合

次のように、生の HTTP API を介して CloudBase のプラットフォーム機能を呼び出す必要がある場合は、このスキルを使用してください。

  • Node.js 以外のバックエンド（Go、Python、Java、PHP など）
  • curl や言語ごとの HTTP クライアントを使用する統合テストや管理スクリプト
  • 关系型数据库 RESTful API（MySQL/PostgreSQL）を介したデータベースの直接操作
  • HTTP によるクラウド関数の呼び出し
  • SDK が利用できない、または望ましくないあらゆるシナリオ

次の場合は、このスキルを使用しないでください。

  • @cloudbase/js-sdk を使用するフロントエンドの Web アプリ（CloudBase Web スキルを使用）
  • @cloudbase/node-sdk を使用する Node.js コード（CloudBase Node スキルを使用）
  • 認証フロー（認証固有のエンドポイントには CloudBase Auth HTTP API スキルを使用）

このスキルの使い方（コーディングエージェント向け）

  1. シナリオを明確にする

    • このコードが SDK ではなく、HTTP エンドポイントを直接呼び出すことを確認します。
    • 次の情報を尋ねます。
      • env – CloudBase 環境 ID
      • 認証方法（AccessToken、API Key、または Publishable Key）
    • 必要な CloudBase の機能（データベース、関数、ストレージなど）を確認します。
    • ユーザー認証の場合：特定の方法が指定されていなければ、必ず Phone SMS Verification をデフォルトとして使用します。中国のユーザーにとって、最も使いやすく安全な方法です。

  2. ベース URL を決定する

    • リージョン（国内または海外）に応じた正しいドメインを使用します。
    • デフォルトは国内の上海リージョンです。

  3. 認証を設定する

    • ユースケースに応じて適切な認証方法を選択します。
    • リクエストに Authorization: Bearer <token> ヘッダーを追加します。

  4. OpenAPI Swagger ドキュメントを参照する

    • OpenAPI 仕様を取得するには、必ず searchKnowledgeBase ツールを使用してください
    • mode=openapi を指定してツールを使用し、apiName を指定します。
      • mysqldb - リレーショナルデータベースの RESTful API（MySQL/PostgreSQL）
      • nosql - NoSQL RESTful API（ドキュメント型データベース）
      • functions - Cloud Functions API
      • auth - 認証 API
      • cloudrun - CloudRun API
      • storage - ストレージ API
      • ai_model - AI 大規模モデル接続 API
    • 例：searchKnowledgeBase({ mode: "openapi", apiName: "mysqldb" })
    • 返された YAML の内容を解析し、正確なエンドポイントパス、パラメーター、リクエスト／レスポンスのスキーマを把握します。
    • エンドポイントやパラメーターを決して推測せず、必ず Swagger ドキュメントを参照してください。

概要

CloudBase HTTP API は、HTTP プロトコルを通じて CloudBase プラットフォームの機能にアクセスするためのインターフェース群です。データベース、ユーザー認証、クラウド関数、クラウドホスティング、クラウドストレージ、AI などをサポートします。

OpenAPI Swagger ドキュメント

⚠️ 重要：OpenAPI Swagger 仕様を取得するには、必ず searchKnowledgeBase ツールを使用してください

HTTP API 呼び出しを実装する前に、次の手順を実行してください。

  1. searchKnowledgeBase ツールを使用して OpenAPI ドキュメントを取得します。

    searchKnowledgeBase({ mode: "openapi", apiName: "<api-name>" })

  2. 利用可能な API 名：

    • mysqldb - リレーショナルデータベースの RESTful API（MySQL/PostgreSQL）
    • nosql - NoSQL RESTful API（ドキュメント型データベース）
    • functions - Cloud Functions API
    • auth - 認証 API
    • cloudrun - CloudRun API
    • storage - ストレージ API
    • ai_model - AI 大規模モデル接続 API

  3. Swagger ドキュメントを解析して使用します：

    • 正確なエンドポイントパスと HTTP メソッドを抽出します。
    • 必須および任意のパラメーターを把握します。
    • リクエスト／レスポンスのスキーマを確認します。
    • 認証要件を確認します。
    • エラーレスポンスの形式を確認します。

  4. API エンドポイントやパラメーターを決して推測せず、必ず公式の Swagger ドキュメントに基づいて実装してください。

前提条件

開始する前に、次の準備ができていることを確認してください。

  1. CloudBase 環境が作成され、有効化されている
  2. 認証情報（AccessToken、API Key、または Publishable Key）

認証と認可

CloudBase HTTP API には認証が必要です。ユースケースに応じて適切な方法を選択してください。

AccessToken 認証

適用環境：クライアント／サーバー
ユーザー権限：ログインユーザーの権限

取得方法：searchKnowledgeBase({ mode: "openapi", apiName: "auth" }) を使用して認証 API の仕様を取得します。

API Key

適用環境：サーバー
ユーザー権限：管理者権限

⚠️ 警告：トークンは本人確認に使用する重要な認証情報です。安全に保管してください。API Key をクライアント側のコードで使用してはいけません。

公開可能なキー

適用環境：クライアント／サーバー
ユーザー権限：匿名ユーザーの権限

💡 注：ブラウザーで公開でき、一般公開されているリソースへのリクエストに使用できます。これにより、MAU を効果的に削減できます。

API エンドポイント URL

CloudBase HTTP API では、API 呼び出しに統一ドメイン名を使用します。ドメインは環境のリージョンによって異なります。

国内リージョン

上海（ap-shanghai）などの国内リージョンにある環境では、次を使用します。

https://{your-env}.api.tcloudbasegateway.com

{your-env} を実際の環境 ID に置き換えます。たとえば、環境 ID が cloud1-abc の場合は、次のようになります。

https://cloud1-abc.api.tcloudbasegateway.com
国際リージョン

シンガポール（ap-singapore）などの国際リージョンにある環境では、次を使用します。

https://{your-env}.api.intl.tcloudbasegateway.com

{your-env} を実際の環境 ID に置き換えます。たとえば、環境 ID が cloud1-abc の場合は、次のようになります。

https://cloud1-abc.api.intl.tcloudbasegateway.com

リクエストでの認証の使用

リクエストヘッダーにトークンを追加します。

Authorization: Bearer <access_token/apikey/publishable_key>

:::warning Note

実際に呼び出す際は、山かっこ（< >）を含む部分全体を、取得したキーに置き換えてください。たとえば、取得したキーが eymykey の場合は、次のように入力します。

Authorization: Bearer eymykey

:::

拡張ガイド

詳しいシナリオ、例、パターンについては、extended-guide.mdをお読みください。

リファレンスインデックス

パッケージに含まれるすべてのリファレンスファイル（スキルの到達可能性の検証に必要です）：

コメント

Markdown 対応