Assertion Blocks

Assertions help you double-check that your API is behaving itself. Think of them as little guards that say, “Hey response… are you sure you’re correct?”
Voiden proudly supports Assertions as a reusable block, because why should only your code get superpowers?

Note: Make sure the Assertion Plugin is enabled — without it, your assertions are basically on vacation.

---

How to Use the Assertion Block

1. Add the Block
   Type /assertion-block and—poof!—your assertion template appears like a magician’s trick (minus the smoke).

---

2. Run It
   Give your request a gentle nudge by either:
   • Pressing Cmd + Enter (on macOS) or Ctrl + Enter (on Windows/Linux), or
   • Clicking the big, bright green Play button—the one that screams “press me!”

---

3. Check the Results
   Slide over to the Response Panel — you’ll spot your shiny new Assertion Check waiting to tell you if things went perfectly… or hilariously wrong.

---

Generate Assertions from the Response

Don't feel like writing every assertion by hand? You don't have to.

Run your request, and right on the assertion block you'll see a Generate Assertion from Response button appear. Click it and Voiden looks at what came back — request headers, response headers, and the body — and builds out assertion rows for them automatically, matched against the values you just got.

It's the fastest way to lock in a "this is what a good response looks like" snapshot, which you can then tweak, trim, or loosen up as needed.

---

Available Operators

Operator	Aliases	Description
equals	eq, ==, ===	Exact equality
not-equals	ne, !=, !==	Not equal
contains	includes	String contains
not-contains	not-includes	String does not contain
starts-with	startswith	String starts with
ends-with	endswith	String ends with
matches	regex	Regex pattern match
exists	is-defined	Value exists
not-exists	is-null, is-undefined	Value does not exist
greater-than	gt, >	Greater than (numeric)
less-than	lt, <	Less than (numeric)
greater-equal	gte, >=	Greater or equal (numeric)
less-equal	lte, <=	Less or equal (numeric)
is-empty	empty	Empty array/string/object
not-empty	None	Not empty
is-truthy	truthy	Truthy value
is-falsy	falsy	Falsy value
type-is	typeof	Type check

---

Available fields

Field	Example
status	200
statusText	OK
responseTime	500
duration	1000
header	header.Content-Type might have applcation/json
body	body.data[0].id would read the id from { "data": [ { "id": 0} ] }

---

Summary

Assertion blocks are your API's quality check — drop one in with /assertion-block, run your request, and head over to the Response Panel to see exactly what passed and what didn't. Don't want to write them by hand? After running your request, hit Generate Assertion from Response and let Voiden build assertions from your request headers, response headers, and body for you. You can check status codes, status text, response time, headers, and body fields, with a solid set of operators covering everything from simple equality to regex matching and type checks. Just make sure the Assertion Plugin is enabled and you're good to go.