testapilocally.com

Signoff Studio Docs

Cookies & utilities

Bottom utility bar: Search, Cookies, Console, Dev Tools, and Preferences. Shared across API / Runner / DB on both Windows and VS Code.

Workspace search

  • Platform Availability: Full Parity
  • Overview: Instant filter across requests by name, method, and URL so large collections stay navigable without scrolling the whole tree.
  • How It Works (Windows App):
    1. Click Search on the bottom utility bar.
    2. Type a fragment (GET, pets, /status).
    3. Click a hit to open the request tab.

Windows utility search

  • How It Works (VS Code Extension):
    1. Same Search panel in the webview.
    2. Works even when the sidebar tree is collapsed.
    3. Pair with Command Palette host commands for workspace-level actions.

VS Code utility search

  • Code / Configuration Examples:
Query examples:  GET   pets   {{baseUrl}}   /oauth
  • Edge Cases, Troubleshooting & Pro-Tips:
    • Empty query shows a “Start typing” empty state — not the full list.
    • Search is local to the loaded workspace, not Marketplace docs.

Cookie jar

  • Platform Availability: Partial (UI Full Parity; persistence path differs)
  • Overview: View cookie-related response headers and manage jar behavior with Settings sendCookies / storeCookies. Jars persist per host profile.
  • How It Works (Windows App):
    1. Send an authenticated request that sets cookies.
    2. Open Cookies on the utility bar to inspect exposed cookie headers.
    3. Clear or adjust jar policy under Settings → General when sessions go stale.

Windows utility cookies

  • How It Works (VS Code Extension):
    1. Same Cookies panel in the shared shell.
    2. Persistence uses ~/.signoff/http-cookies/vscode.json (VS Code profile).
    3. Desktop and VS Code jars do not automatically share cookies.

VS Code utility cookies

  • Code / Configuration Examples:
{
  "general": {
    "sendCookies": true,
    "storeCookies": true
  }
}
  • Edge Cases, Troubleshooting & Pro-Tips:
    • Secure cookies require https:// targets.
    • Cross-host APIs won’t send host-only cookies — check domain/path attributes.

GAP IDENTIFIED: Cookie jar file paths differ between Windows desktop and VS Code. Expect separate sessions when hopping hosts; export tokens via environments if you need portable auth.

Console

  • Platform Availability: Full Parity
  • Overview: Runtime, script, and diagnostic events. Preferences control auto-open on error, preserve across sends, compact rows, and anonymous product ping.
  • How It Works (Windows App):
    1. Open Console; send a request or run scripts.
    2. Select an event for detail; clear when noisy.
    3. Tune behavior in Preferences (Ctrl+,).

Windows utility console

Windows preferences

  • How It Works (VS Code Extension):
    1. Same Console + Preferences in the webview.
    2. Enable Open console on errors when debugging Tests/Pre-request.
    3. Product ping never includes request bodies.

VS Code utility console

  • Code / Configuration Examples:
// In Tests
qa.test("status 200", () => {
  qa.expect(qa.response.code).to.equal(200);
});
  • Edge Cases, Troubleshooting & Pro-Tips:
    • With preserve off, previous send logs disappear — turn on when comparing two failures.
    • Diagnostic Logs page (Help/Logs) is separate from the utility Console — use both for deep dives.

Dev Tools

  • Platform Availability: Full Parity
  • Overview: Network timing, raw exchange details, and helper views (including cURL copy) after a response is available.
  • How It Works (Windows App):
    1. Send a request.
    2. Open Dev Tools on the utility bar.
    3. Copy cURL or inspect timing/network panels.

Windows utility dev tools

  • How It Works (VS Code Extension):
    1. Same Dev Tools panel after a send.
    2. Paste copied cURL into terminals or Issue repros.
    3. For missing response UI, run Signoff Studio: Restore Response Panel.

VS Code utility dev tools

  • Code / Configuration Examples:
curl -sS -X GET "https://httpbingo.org/get?product=signoff" -H "Accept: application/json"
  • Edge Cases, Troubleshooting & Pro-Tips:
    • Dev Tools empty state means no response yet — send first.
    • Timing for WS/SSE streams differs from unary HTTP — use Stream tabs for live protocols.

Preferences (utility)

  • Platform Availability: Full Parity
  • Overview: Lightweight preferences for console + appearance entry points. Full desktop Settings overlay (proxy, certs, updates, AI providers) is Windows-first — see Settings.
  • How It Works (Windows App): Bottom Preferences, Help → Preferences, or Ctrl+,.
  • How It Works (VS Code Extension): Same Preferences surface; no contributes.configuration keys in VS Code.

Windows preferences shortcut

VS Code preferences

  • Code / Configuration Examples: See settings schema console + appearance in Settings.

  • Edge Cases, Troubleshooting & Pro-Tips:

    • Appearance themes also open from the utility palette control.
    • Resetting preferences does not delete workspace collections.

Diagnostic logs page

  • Platform Availability: Full Parity
  • Overview: App-level diagnostic log viewer for support and deep troubleshooting beyond the session Console.
  • How It Works (Windows App): Open Logs from the top bar / Help paths; filter and copy relevant slices.
  • How It Works (VS Code Extension): Same Logs page inside the webview when exposed by the shell chrome.

Windows diagnostic logs

VS Code diagnostic logs

  • Code / Configuration Examples: N/A — UI export/copy only.

  • Edge Cases, Troubleshooting & Pro-Tips:

    • Redact tokens before sharing logs externally.
    • Pair with Troubleshooting when SSL or proxy issues appear.

Related