API仕様書をコードから
自動生成する
Pythonでも、TypeScriptでも、Rubyでも。RepoCartaはあらゆる言語・フレームワークのコードを解析し、エンドポイント・リクエスト・レスポンスを詳細にドキュメント化します。
API仕様書を14日Trialで生成するAPI仕様書を手動で書く負担
APIを持つシステムでは、フロントエンドとバックエンドの連携、外部パートナーとの統合、チーム内のコミュニケーションなど、あらゆる場面でAPI仕様書が必要です。しかし手動でのAPI仕様書作成・維持は、多くのチームにとって大きな負担となっています。
- 実装後のドキュメント化は後回しになり、仕様書が存在しないAPIが量産される
- コードが変更されるたびに仕様書を手動で更新する必要があり、乖離が生じやすい
- フロントエンドエンジニアが「APIの仕様がわからない」とバックエンドに確認する往復コストが発生する
- 外部連携先やモバイルチームへの仕様共有に時間がかかる
- アノテーション（デコレータ）の記述が煩雑で、記述漏れが発生しやすい
RepoCartaが生成するAPI仕様書の内容
RepoCartaは単純なエンドポイント一覧だけでなく、実際に使えるレベルの詳細なAPI仕様書を生成します。
-
エンドポイント一覧
HTTPメソッド・パス・説明を整理した一覧表。認証が必要なエンドポイントには鍵マークを付与。
-
リクエスト仕様
クエリパラメータ・リクエストボディのフィールド名・型・必須/任意を表形式で出力。
-
レスポンス仕様
ステータスコード別のレスポンスボディ構造をJSONサンプルとともに表示。エラーレスポンスも網羅。
-
認証・認可の説明
APIキー・JWT・OAuth2などの認証方式と、各エンドポイントに必要な権限レベルを明記。
対応フレームワーク
主要なWebフレームワーク・APIフレームワークに対応しています。フレームワーク固有のルーティング定義・デコレータ記法を理解した上でドキュメントを生成します。
OpenAPIとの違い
OpenAPI（旧Swagger）はAPI仕様を記述するための標準仕様ですが、アノテーションの記述や専用ファイルの管理が必要で、実装とドキュメントを常に同期させるのが困難です。RepoCartaはコードを直接解析するため、アノテーション不要で既存コードからそのままドキュメントを生成できます。
| 比較項目 | OpenAPI / Swagger | RepoCarta |
|---|---|---|
| 既存コードへの追加作業 | 要アノテーション追記 | 不要（コードをそのまま解析） |
| セットアップの手軽さ | ライブラリ導入・設定が必要 | GitHubと連携するだけ |
| コードとの同期 | 手動で維持が必要 | 自動更新（Webhook連携） |
| アーキテクチャ説明 | 非対応 | API以外の設計書も生成 |
| 既存コードへの適用 | レガシーコードは困難 | 既存コードにそのまま対応 |
| OpenAPIスペック出力 | ネイティブ対応 | OpenAPI形式でエクスポート可能 |
RepoCartaはOpenAPIと競合するものではなく、補完関係にあります。RepoCartaで生成したAPI仕様書をOpenAPI形式でエクスポートし、SwaggerUIやRedocで表示することも可能です。アノテーションを書かずにOpenAPI仕様書を得る手段として活用できます。