Guides

Practical, task-focused walkthroughs. They assume you've read the concepts; if a term is unfamiliar, start there.

• Importing a spec: import and re-import an OpenAPI spec, and resolve the diff.
• Request instances: create, override, and run requests from the app and the CLI.
• Auth & middlewares: bearer and API-key auth, custom script auth, and before/after request hooks.
• Writing workflows: chain requests across your APIs into a multi-step test, with assertions, branches, and loops.
• Documenting an API: write Markdown docs with live spec data.
• CI/CD: run requests and workflows in a pipeline.
• Pro license: install the license file, check its status, and what happens when it expires.

The rule of thumb across all of them: author in the app, run and automate with the CLI.