# API仕様横断検索 — 運用ガイド

## 基本情報

| 項目 | 内容 |
|------|------|
| 業種 | システム開発 |
| ユースケース | API仕様横断検索 |
| WFパターン | `` |
| RAG | あり |
| 検証結果 | E2E pass |
| デモURL例 | https://dify.ddf-cloud.com/workflow/s8xHaGdGLV0avz1d |

## 概要



## デモ手順

1. DDF Web UI (`/dashboard`) を開く
2. 「API仕様横断検索」の「デモ生成」ボタンをクリック
3. 業種「システム開発」、UC「API仕様横断検索」が自動入力される
4. 「デモ生成開始」をクリック
5. 生成完了後、デモURLを顧客に共有

## ナレッジベース（RAG）

このワークフローにはナレッジベースが必要です。

### 同梱ドキュメント

バンドル内の `knowledge/` フォルダに以下のテキストファイルが保存されています:

- `ユーザー取得 API — GET _v1_users_{user_id}.txt`
- `支払い作成 API — POST _v1_payments.txt`
- `APIゲートウェイ 認可・レート制御 ガイドライン.txt`

### デプロイ手順

1. Dify管理画面 → ナレッジ → 新規作成
2. 上記テキストファイルをアップロード
3. インデキシング完了を待つ
4. WFのKRノードで作成したナレッジベースを選択

またはDDFパイプラインで自動セットアップ:
```
run_pipeline(knowledge_docs=[...])  # 自動でKB作成+ID注入
```

**顧客デモ時は、顧客の実ドキュメントに差し替えるとインパクトが大きくなります。**


## 顧客への説明ポイント

- 「これは自動生成されたプロトタイプです。本番利用には追加の設計・開発が必要です」
- 「御社の実データ/ドキュメントを使えば、さらに精度の高いデモをお見せできます」
- 「Self-hostedなので、御社のデータは外部に出ません」

## AI品質評価コメント

合格。出力は空ではなく意味のあるテキストが提供されており（1）、ユースケース（複数のAPI仕様を横断してエンドポイント仕様を統合する）に直接関連した内容を含んでいます（2）。顧客デモとして十分な具体性と実務的な確認項目・推奨アクションがあり品質は最低限満たしています（3）。入力クエリ固有の要素を明確に扱っており、GET /api/v2/orders/{orderId} や path param orderId、Authorization ヘッダ、X-Internal-APIKey、If-None-Match、R001 のレート制限表現やガイドライン出典など具体的に言及しています（4）。また汎用テンプレートのみではなく、ソース参照・想定ステータス・エラーパターン・実務優先アクション等の統合的な記述が含まれており定型文だけで構成されていません（5）。なお、出力自身も『OpenAPIが未提供のため確定情報は取得を要する』旨を明示しており適切な注意喚起がなされています。

## 次のステップ（受託提案）

1. 顧客の実データでカスタマイズデモ（POC: 5-10万円）
2. 本番環境設計・構築（受託開発）
3. 既存システム（kintone/Salesforce等）とのAPI連携
4. 運用保守サポート