Here is a list of what we achive at the end of this tutorial:

• Setup Proxyman with your Mac
• Capture Request/Response from your Web Browser or iPhone app
• Generate OpenAPI 3.0 as a YAML files or HTML Documentation.

Video Demo:

• Click to play:

Prerequisites

• Download the current Proxyman macOS release. OpenAPI export is included in the normal app, so the old beta build is no longer needed.

Capture HTTPS traffic from macOS

Before starting, make sure you have Proxyman installed on your Mac you have installed and trust Proxyman Certificate on your Mac.

If you're a new users, please follow the Getting Started Guide for macOS which helps you set up your Mac.

Finally, try opening www.producthunt.com or anywebsite in your browser and capture the traffic. Proxyman now can capture and decrypt HTTPS traffic from your browser.

Capture HTTPS traffic from iPhone

To capture HTTPS traffic from iPhone, you need to follow the Setup Guide for iOS Physical devices. Please follow the Setup Guide for iOS Physical devices to setup your iPhone.

After setup, you can capture HTTPS traffic from your iPhone.

Generate OpenAPI 3.0 YAML

It's very easy to generate OpenAPI 3.0 YAML from Proxyman.

1. Select the Request/Response you want to generate OpenAPI 3.0 YAML from.
2. Right Click -> Export -> OpenAPI -> YAML
3. Select a place to save the file.
4. Done

It's how YAML file looks like when opening it from Swagger Editor

Generate OpenAPI 3.0 HTML Documentation

Instead of select YAML, you can select HTML to generate OpenAPI 3.0 HTML Documentation.

Conclusion

Proxyman is a powerful tool that helps you capture and inspect HTTP/HTTPS traffic from your browser or mobile app. With the ability to generate OpenAPI 3.0 YAML or HTML Documentation, you can now easily share your API documentation with your team or clients.

Treat the generated file as a strong starting point, not a finished contract. Capture more than one example for endpoints with optional fields, and review parameter types, required values, error responses, authentication, and private example data before publishing it. A real traffic sample can show what happened once, but it cannot describe every response the server may return.

What's next?

• Read OpenAPI 3.0 Specification: OpenAPI Specification
• Read more about Proxyman: Proxyman Documentation
• OpenAPI Export Documentation: OpenAPI Export Documentation