OpenAPI DevTools - API仕様を自動生成するChrome拡張機能

(github.com/AndrewWalsh)

3 ポイント投稿者 GN⁺ 2023-10-26 | 1件のコメント | WhatsAppで共有

Webページのネットワークリクエストに基づいてリアルタイムでOpenAPI仕様を生成
Chrome DevToolsに「OpenAPI」という新しいタブを追加
- Webサイトやアプリケーションに対するOpenAPI 3.1仕様を即座に生成
- エンドポイントごとに新しいリクエストおよびレスポンスのヘッダー、本文、クエリパラメータを自動マージ
- パスパラメータをクリックすると、既存および今後一致するリクエストをマージ
- Redoclyを使ってツール内で仕様を閲覧でき、クリックでダウンロード可能
拡張機能はWebの探索中に発生するJSONリクエストに基づいて仕様を自動的に埋める
設定メニューでホストをフィルタリングし、URLのパスをパラメータ化できる
同じエンドポイントが異なるデータで応答しても、拡張機能は最終仕様にすべての情報を含める
リクエストのマージ処理は元に戻せないが、ユーザーは仕様を消去していつでもやり直せる

1件のコメント

GN⁺ 2023-10-26

OpenAPI DevTools の Chrome 拡張機能は、API 仕様を生成する能力が評価されている。
ユーザーは、複雑な作業をすばやく実行できる JavaScript コンソールにコードを書く際に便利だと考えている。
このツールへの提案の1つは、認証ヘッダーを文書化し、トークン値を保存して API の利用を容易にすることだ。
「Python リクエストにコピー」ボタンで Python のボイラープレートスニペットを生成する機能要望が出された。
このツールは、vite-plugin-web-extension や mitmproxy2swagger のような類似ツールと比較され、ブラウザー拡張機能が非常に便利である点が強調された。
このツールは、Web サイトの API を解読する能力が称賛されたが、これは厄介な作業になり得る。
このツールがオプション値を処理し、文字列フィールドを「列挙型」として表示する能力について疑問が提起された。
このツールは、ログイン／登録の障壁があるにもかかわらず、Web 全体を API に変える方向性として見ることができる。
レスポンス属性のフィルタリング、非 JSON データの処理、公開文書化された API とホスト名のクロスリファレンス、ユーザー認証情報のローカル保存、OpenAPI 仕様に基づくクライアント生成など、複数の機能提案が挙がった.