• FAIL
  • PASS
  • HUMAN
  • LOG

AIを活用してApiaryのAPI仕様書を自動検証する方法

Apiaryをエージェントに接続すれば、稼働中のエンドポイントが設計通りであることを確認できます。設計図をそのままテストスイートへと変貌させます。

このページについてAIに聞く

すぐに答え

APIが設計通りか確認するには?

AIがApiaryを使用して、現在の設計図に基づいた自動テストを実行します。実装が仕様から逸脱している箇所を正確に特定し、契約違反や設計の不一致をリストアップします。

テスト結果の分類

結果の出力先

AIがテストを実行し、その結果を以下のカテゴリに整理します。

FAIL

契約違反

実装が設計図を満たしていない特定のエンドポイントを特定します。リクエストやレスポンスが一致しなかった正確な理由を提示します。

PASS

検証済みエンドポイント

APIのどの部分が設計通りに動作しているかを確認します。これにより、次の機能開発へ自信を持って進めます。

HUMAN

設計判断

設計自体に欠陥があるためにテストが失敗した場合、AIがその旨を通知します。コードを修正すべきか、設計図を更新すべきかを判断できます。

LOG

テスト履歴

AIが実行結果を記録します。過去の検証結果を振り返り、最近の変更によって既存の仕様が壊れていないかを確認できます。

ワークフロー

設計図が届いた際、AIが行うこと

実行と比較という重い作業はすべてAIが引き受けます。

  1. 設計図の読み込み

    エージェントがApiaryプロジェクトから最新のAPI設計を取得し、信頼できる情報源(Source of Truth)を確立します。

    run_tests
  2. 検証の実行

    仕様書で定義されたルールに従い、稼働中のエンドポイントに対して自動テストスイートを実行します。

    run_tests
  3. 結果の比較

    実際のHTTPレスポンスと、設計図が期待するスキーマをエージェントが照合します。

    run_tests
  4. 不一致の報告

    AIが不一致を要約し、不足しているフィールドや誤ったデータ型を明確にします。

    run_tests

試してみる

以下のプロンプトをコピーして開始

これらのプロンプトを使って、最初の検証を実行しましょう。

出発点

括弧内のテキストを、実際のプロジェクト名やエンドポイントURLに書き換えてください。

Apiary Connector

準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。

コネクタリンクhttps://edge.vinkius.com/vk_preview_UAsHBD3gjamXcRpVpwIeIHmn77OKcfcfMA4F8oBO/mcp

Claude Desktop

以下の手順で数秒で接続できます。

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — Apiary capabilities are ready to use.
設定 · claude_desktop_config.jsonコピー
{
  "mcpServers": {
    "apiary-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_UAsHBD3gjamXcRpVpwIeIHmn77OKcfcfMA4F8oBO/mcp"
    }
  }
}
チャットにコピー04
  • Apiaryにある'User-Service'の設計図に対してテストを実行して。

  • 現在の実装が'Payments-API'の仕様と一致しているか確認して。

  • 'Auth-Module'の設計図のエンドポイントを検証して、失敗した箇所を教えて。

  • 'Inventory-API'に対してテストスイートを実行し、不一致の内容をまとめて。

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

ここから始める

Apiaryを一度接続すれば、あとは指示するだけ

Apiaryアカウントを連携するだけで準備完了です。認証情報は暗号化されて保持されるため、すぐにエージェントへテスト実行を指示できます。

ApiaryをAIに接続する

FAQ

動作について

  • 01

    AIがAPIの設計を変更することはありますか?

    いいえ。AIはテストを実行するために設計図を読み取るだけです。Apiaryの仕様書やコードを直接書き換えることはできません。

  • 02

    AIがコードをデプロイすることはありますか?

    いいえ。AIは既存の実装に対してテストを実行するのみです。コードをプッシュしたり、サービスをデプロイしたりする権限は持っていません。

  • 03

    テストが失敗した場合はどうなりますか?

    AIが不足しているフィールドや型エラーなどの具体的な不一致を報告します。それに基づき、修正を行うことができます。

  • 04

    特定のエンドポイントだけをテストできますか?

    はい。設計図全体ではなく、設計図内の特定の箇所を対象にするようエージェントに指示できます。

  • 05

    AIはどのAPIをテストすべきかどうやって判断しますか?

    Apiary経由で接続された設計図を使用して、期待される動作とエンドポイントを特定します。

  • Apiaryについてさらに詳しく知りたいですか? Apiary Connectorの全機能を見る

『Apiary』を Claude、Cursor、ChatGPT などに接続