Apidogでは、まずリクエストを送信し、そのリクエストを直接API仕様として保存することができます。1
Apidogで「新しいRequest」をクリックします。
2
次のURLをアドレスバーに貼り付けます:
https://mock.apidog.com/m1/710637-685828-default/category/1
4
「APIとして保存」をクリックして、このリクエストをAPIとして保存します。
5
「プレビュー」タブに切り替えて、API仕様を確認します。
インターフェースが上記の画像と一致しない場合は、「リクエスト優先」モードに切り替えてください。 実際に送信されたリクエストとレスポンスはAPIの例となり、スキーマは自動的に解析され生成されます。これはAPI仕様を生成する最も便利な方法です。この方法で生成されたAPI仕様は、REST APIのクエリパラメータを認識できますが、パスパラメータを認識することはできません。例えば、上記のケースでは、正しいリクエストURL仕様は/category/{id}
であるべきですが、実際のリクエストでは整数の1
であったため、{id}
として認識されませんでした。API仕様のパスで手動で{id}
に変更する必要があります。