キャプチャしたHTTPSリクエストをApifoxにエクスポートする方法

キャプチャしたHTTPSリクエストをApifoxにエクスポートする方法

ApiCatcherはキャプチャ中にHTTPリクエストからリアルタイムでAPIドキュメントを自動生成し、複数回のキャプチャからレスポンスフィールドを自動統合して更新します。

JSONまたはForm-DataのContent-Typeを持つHTTP/HTTPSリクエストのみドキュメント化し、Hostごとにグループ化します。Host単位の一括エクスポートと単一APIエクスポートの両方をサポートしています。

エクスポート手順

Host APIリスト画面またはAPI詳細画面で、右上のエクスポートボタンをタップします。 Host APIリスト

「Apifoxにエクスポート」を選択します。

APIエクスポート

ステップ1: Apifox API Keyを取得

APIアクセストークン にアクセスし、手順に従ってAPI Keyを生成します。取得したキーをApiCatcherに入力すれば、次回以降は自動で記憶されます。

ステップ2: プロジェクトIDを取得

Apifoxで対象プロジェクトを開き、プロジェクト設定の基本設定からプロジェクトIDを確認します。

ApifoxプロジェクトIDの取得

ステップ3: ディレクトリIDを取得(任意)

特定ディレクトリにエクスポートする場合は、該当ディレクトリのIDを事前に確認します。未指定の場合はルートにエクスポートされます。

ApifoxディレクトリIDの取得

プロジェクトの「APIs」タブで対象ディレクトリをクリックし、右側の「ディレクトリ設定」からIDを確認します。

エクスポート実行

右上のエクスポートボタンをクリックすると、完了後に成功/失敗が表示されます。