testapilocally.com

Signoff Studio Docs

Quick Start

Complete these steps in order. Use the Signoff Studio Starter Guide collection — the same suite we run against httpbingo for product demos.

Before you begin

  1. Install Signoff Studio.
  2. Download:

1. Import the Starter Guide

Objective: Load the demo collection into Signoff Studio.

  1. Click Import (or choose Import Existing Project on Welcome).
  2. Stay on the Collections tab.
  3. Click Choose collection JSON and select signoff-studio-starter.signoff.json.

Import Collections

  1. Click Import again → Environments.
  2. Import signoff-studio-starter.httpbingo.signoff.env.json.

Import environment

Success criteria

  • Sidebar shows Signoff Studio Starter Guide with folders 01, 02, 05, and 06.
  • Environment httpbingo appears in the top-bar switcher.

2. Select the environment

Objective: Resolve {{baseUrl}} to https://httpbingo.org.

  1. Open the environment switcher (globe).
  2. Select httpbingo.

Environment switcher

Success criteria

  • Top bar shows httpbingo (not None).

3. Send your first request

Objective: Execute GET · Query Params and read a 200 response.

  1. In the sidebar, expand 01 - GET & Query.
  2. Open GET · Query Params.
  3. Confirm the URL is {{baseUrl}}/get?product=signoff&suite={{suiteName}}&page=1.
  4. Click Send (or press Ctrl+Enter).

First successful response

Success criteria

  • Status is 200.
  • Pretty JSON shows args.product = signoff and args.suite = signoff-starter (variable resolved).

4. Send JSON

Objective: POST a JSON body.

  1. Open 02 - JSON Bodies → POST · JSON Create.
  2. Open the Body tab — type should be JSON.
  3. Click Send.

JSON body request

Success criteria

  • Status is 200.
  • Response echoes the JSON you sent.

5. Authenticate

Objective: Call an endpoint with Bearer auth from the environment.

  1. Open 05 - Auth → GET · Bearer Token.
  2. Open the Auth tab — type is Bearer token, value {{bearerToken}}.
  3. Click Send.

Bearer auth

Success criteria

  • Status is 200.
  • Response shows authenticated: true.

6. Read a test script

Objective: See how Signoff asserts responses with qa.test.

  1. Stay on GET · Bearer Token (or reopen it).
  2. Open the Tests tab.
  3. Review the qa.test(...) script that checks status and body.

Tests tab

Success criteria

  • You can identify at least one qa.test that checks status 200.

More: Tests & scripts

7. Run the collection

Objective: Execute the Starter Guide in Runner.

  1. Switch to Runner.
  2. Select collection Signoff Studio Starter Guide.
  3. Leave All folders selected (8 requests).
  4. Click Run.

Collection Runner ready

Success criteria

  • Runner shows the eight requests in the execution plan.
  • After Run, passed/failed counts update in the stats bar.

More: Collection Runner

What’s next

Topic Guide
Variables in depth Environments
Auth types Authentication
Import from Postman/Bruno Import & export
SQL checks Database
Folder workspaces Workspaces