Claudeコードスキルを構築し、文書化されていないAPIを... ノート

Claudeコードスキルを構築し、文書化されていないAPIをリバースエンジニアリングしました

著者は新しいチームに参加し、すぐに古いAPIドキュメントに直面し、コードベースを手動でgrepしてルートを検索する必要に迫られました。この4時間にわたる苦難は、多くの開発環境で一般的となっている、存在しない、または不正確なドキュメントという問題を浮き彫りにしました。この問題に対処するため、著者はClaude Code / Codex CLIのスキルであるAPI Archaeologistを開発しました。これは、ソースコードから直接APIレイヤーをリバースエンジニアリングするように設計されています。このツールは、内部エンドポイント(REST、GraphQL、gRPC、WebSockets)、外部統合、認証フロー、認証されていないルートのような潜在的なセキュリティギャップなど、さまざまなAPI要素を自動的に検出します。API Archaeologistは、API_DISCOVERY.md(Mermaid図を含む包括的なカタログ)とopenapi-draft.yaml(予備的なOpenAPI仕様)という2つの主要な出力を生成します。既存のアノテーションや仕様に依存するツールとは異なり、API Archaeologistは実際のソースコードを分析するため、レガシーシステム、スタートアップ、または急速な開発を行うプロジェクトに最適です。このスキルは、Claude Codeにルート定義、ハンドラー、ミドルウェア、データベース呼び出しをトレースし、認証をマッピングし、外部API呼び出しを特定するように指示するSKILL.mdファイルを読み込むことで動作します。インストールには、スキルのためのディレクトリを作成し、Claude CodeまたはCodex CLIのいずれかのSKILL.mdファイルをダウンロードします。その後、ユーザーはバックエンドリポジトリに移動し、簡単なコマンドを実行してレポートを生成します。著者は、コードベース内にすでに埋め込まれている貴重な情報の膨大な量という、得られた核心的な洞察は、抽出と接続が必要なだけであると強調しています。OpenAPIの出力はドラフトであり、動的なルーティングは課題となる可能性がありますが、このツールはAPIドキュメントを合理化することを目指しています。将来の計画には、フロントエンドAPIコンシューマーマッピング、Postmanコレクションのエクスポート、CI/CD統合が含まれます。API Archaeologistは、コードを直接解釈することで、古いまたは欠落したAPIドキュメントに苦労しているチームにソリューションを提供します。