REST API の OpenAPI 3.0 を数クリックで生成
このチュートリアルの最後には、次のことができるようになります：
- Mac に Proxyman をセットアップする
- Web ブラウザや iPhone アプリからリクエスト/レスポンスをキャプチャする
- OpenAPI 3.0 を YAML ファイルまたは HTML ドキュメントとして生成する
デモ動画
- 再生をクリック：
前提条件
- 最新の Proxyman macOS をダウンロードしてください。OpenAPI の書き出しは通常版のアプリに含まれているため、古いベータ版はもう必要ありません。
macOS から HTTPS 通信をキャプチャ
始める前に、Mac に Proxyman がインストールされていて、Proxyman の証明書を Mac で信頼していることを確認してください。
初めて使う方は、macOS 向けの導入ガイドに従って Mac をセットアップしてください。
最後に、ブラウザで www.producthunt.com などの任意のウェブサイトを開いて、通信をキャプチャしてみてください。Proxyman は、ブラウザからの HTTPS 通信もキャプチャして復号できるようになりました。
iPhone から HTTPS 通信をキャプチャ
iPhone から HTTPS 通信をキャプチャするには、iOS 実機向けのセットアップガイドに従う必要があります。iPhone をセットアップするには、iOS 実機向けのセットアップガイドに従ってください。
セットアップが完了したら、iPhone から HTTPS 通信をキャプチャできます。
OpenAPI 3.0 YAML を生成
Proxyman から OpenAPI 3.0 YAML を生成するのはとても簡単です。
- OpenAPI 3.0 YAML を生成したいリクエスト/レスポンスを選択します。
- 右クリックして、Export → OpenAPI → YAML の順に選択します。
- ファイルの保存先を選択します。
- 完了です。
Swagger Editor で開いた YAML ファイルの見た目は次のとおりです。
OpenAPI 3.0 の HTML ドキュメントを生成
YAML を選ぶ代わりに HTML を選択すると、OpenAPI 3.0 の HTML ドキュメントを生成できます。
まとめ
Proxyman は、ブラウザやモバイルアプリの HTTP/HTTPS 通信をキャプチャして確認できる強力なツールです。OpenAPI 3.0 の YAML や HTML ドキュメントを生成できるため、API ドキュメントをチームやクライアントと簡単に共有できます。
生成されたファイルは完成した契約書ではなく、あくまでたたき台として扱ってください。任意フィールドを持つエンドポイントは複数の例をキャプチャし、公開する前にパラメータの型、必須の値、エラーレスポンス、認証、非公開のサンプルデータを確認してください。実際の通信のサンプルは一度起きたことを示せますが、サーバーが返しうるすべてのレスポンスを表すことはできません。
次のステップ
- OpenAPI 3.0 仕様を読む: OpenAPI Specification
- Proxyman の詳細を読む: Proxyman ドキュメント
- OpenAPI の書き出しについて: OpenAPI 書き出しのドキュメント
