Build Insomnia

The build, in order

1. 1

   Runner

   hideshow

   One request from YAML with substitution; secrets from the shell only.

   1. 1.1Create the CLI and define requests/*.yaml and environments/*.yaml
      terminalcopy

      mkdir api-cli && cd api-cli && git init && npm init -y && npm pkg set type=module && npm install yaml@2
      mkdir -p requests environments && cp .env.example .env

   2. 1.2Implement api run <file> --env <name> with {{var}} and {{env.NAME}} substitution and pretty output

   done when · tick each as it passes

   • GET and POST work
   • A missing variable fails naming itself
   • No secret can be committed

   next phase
2. 2

   Assertions and chaining

   hideshow

   Non-zero exit on failure; a token captured into the next call.

   1. 2.1Status and JSON-path asserts, exit 1 with a diff
   2. 2.2capture into variables for later requests in a folder run

   done when · tick each as it passes

   • A login feeds a token to the next call
   • A wrong status exits 1

   next phase
3. 3

   History

   hideshow

   Every run to SQLite; list and diff.

   1. 3.1Record runs with status, latency, size and body hash
   2. 3.2api history and api diff commands

   done when · tick each as it passes

   • Diff shows a changed field between the last two runs

   next phase
4. 4

   Local UI

   hideshow

   A localhost page listing requests, running one, showing the response.

   1. 4.1Serve a server-rendered page on API_UI_PORT listing requests
   2. 4.2Run from a button and show the highlighted response

   done when · tick each as it passes

   • A request edited in the file appears on reload and runs from a button

   next phase
5. 5

   Import

   hideshow

   Insomnia v4 becomes YAML.

   1. 5.1Parse the v4 export into requests and environments
   2. 5.2Run an imported workspace unchanged

   done when · tick each as it passes

   • An exported workspace runs after import

   next phase