几步生成 OpenAPI 3.0，逆向分析 REST API
完成本教程后，你将学会：
- 在 Mac 上设置 Proxyman
- 从网页浏览器或 iPhone 应用中抓取请求/响应
- 生成 OpenAPI 3.0 的 YAML 文件或 HTML 文档。
视频演示：
- 点击播放：
前提条件
- 下载最新版的 Proxyman macOS。OpenAPI 导出功能已包含在正式版应用中，因此不再需要旧的 Beta 版本。
从 macOS 抓取 HTTPS 流量
开始之前，请确保你已在 Mac 上安装 Proxyman，并在 Mac 上信任 Proxyman 证书。
如果你是新用户，请参阅 macOS 快速上手指南，了解如何设置你的 Mac。
最后，可以尝试在浏览器中打开 www.producthunt.com 或任意网站，并抓取其流量。Proxyman 现在可以抓取并解密浏览器中的 HTTPS 流量。
从 iPhone 抓取 HTTPS 流量
要从 iPhone 抓取 HTTPS 流量，你需要按照 iOS 真机的设置指南进行操作。请参阅 iOS 真机设置指南 来设置你的 iPhone。
设置完成后，即可从 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 规范
- 进一步了解 Proxyman：Proxyman 文档
- OpenAPI 导出文档：OpenAPI 导出文档
Noah Tran