Skip to content

usage.md

Latest commit

 

History

History
82 lines (54 loc) · 2.19 KB

usage.md

File metadata and controls

82 lines (54 loc) · 2.19 KB
Raw

Usage Guide

This guide explains how to use TraceAPI after the extension is installed.

Start Capturing

  1. Open a website or web application that makes API requests.
  2. Click the TraceAPI extension icon.
  3. Click Open Panel to open the side panel.
  4. Click Start Capture.
  5. Trigger API activity on the page, such as loading data, submitting a form, or clicking an action that calls an API.

Captured requests appear live in the request list.

Stop Capturing

Click Stop Capture in the side panel. Requests triggered after capture stops are not added to the list.

Clear Captured Requests

Click Clear to remove captured records for the current tab.

Inspect A Request

Select a request from the list to view:

  • Method, URL, status, duration, and source.
  • Request headers.
  • Request payload.
  • Response headers.
  • Response body.
  • Generated Go struct when the response body is valid JSON.

Work With JSON

For JSON request or response bodies, use:

  • Pretty to format JSON with indentation.
  • Minify to compact JSON.
  • Tree to inspect JSON as an expandable tree.
  • Copy JSON to copy formatted JSON.

Generate Go Structs

Open a request with a valid JSON response. In the Go Struct section:

  1. Set the package name.
  2. Set the root struct name.
  3. Click Copy Struct.

The generator supports nested objects, arrays, nullable fields, pointers, and omitempty tags.

Copy Actions

The side panel includes copy actions for:

  • URL.
  • cURL.
  • Request body.
  • Response body.
  • Headers.
  • JSON.
  • Go struct.

When copy succeeds, the button temporarily changes to Copied. If clipboard access fails, it changes to Failed.

Search And Filter

Use the search field to find requests by URL, method, status, headers, request body, or response body.

Use filters to narrow results by:

  • HTTP method.
  • Status class, such as 2xx, 4xx, or 5xx.
  • MIME type, such as json or html.

Security Notes

  • Capture is inactive by default.
  • Captured data is stored locally in memory for the extension session.
  • Sensitive headers such as Authorization, Cookie, Set-Cookie, x-api-key, api-key, and Proxy-Authorization are masked by default.
  • No captured data is sent to external servers.