api-recon-and-docs は何をしますか？
API偵察とドキュメントレビューのプレイブック。エンドポイント、スキーマ、バージョン、OpenAPI仕様、隠しドキュメント、APIテストのためのサーフェスエリアを発見する際に使用します。
使用目的
このプレイブックを使用すると、以下のことが可能です：
- APIエンドポイントの発見: 既知および未知のAPIルートを識別します。
- スキーマとバージョンの確認: APIのデータ構造とバージョン管理方式を理解します。
- OpenAPI仕様の収集: 利用可能な
openapi.jsonやswagger.jsonファイルを見つけます。 - 隠しドキュメントの検出: 開発者向けドキュメント、コメント、内部エンドポイントを探します。
- テスト対象表面積のマッピング: セキュリティテストや機能テストの範囲を決定します。
対象プラットフォーム
- Yaklangエコシステム（Yak、Yakit、Yaklang CLI）
- その他のAPIテストフレームワークと互換性があります。
使い方
- プロジェクトのルートに
api-scan.yaml設定ファイルを配置します。 - 対象APIの基本URLを指定します。
- 以下のコマンドを実行します：
yak run api-recon-and-docs
設定例 (api-scan.yaml)
api:
base_url: "https://example.com/api/v2"
discovery:
- endpoints: ["/users", "/products", "/orders"]
- schema: true
- docs: true
出力例
- エンドポイント一覧: すべての検出されたエンドポイントのリスト。
- OpenAPI仕様: 利用可能なスキーマのサマリー。
- 潜在的な問題: 認証がない、CORS設定ミス、未使用のエンドポイントなど。
トラブルシューティング
- 設定ファイルが見つからない場合：
api-scan.yamlが現在のディレクトリにあることを確認してください。 - ネットワークエラー：APIサーバーにアクセスできること、適切な権限があることを確認してください。
- 不完全な結果：APIにドキュメントが公開されていない可能性があります。手動でエンドポイントを追加してみてください。