Skip to content
CheckcraftDownload
Practical workflow

API checks from analyst requirements: how to write them and see the coverage

Checkcraft is a desktop app for checking APIs and logs without code, with a free edition. Download, no sign-up →

"The order is created correctly" cannot be checked. "Status 201, total equals the sum of the items" can. The difference is whether the expected value is written down.

Checkcraft ·

Get help with your first test →

What "a check from a requirement" means

A check answers "yes or no". So every requirement has to give you three things: what to look at (a response field, a status code, a log record), how to compare (equals, greater than, not empty, sum) and what to compare with. The third matters most: the expected value comes from the requirement, a formula or a reference list. If you copy it from the current API response, the check confirms what was built rather than what was ordered.

How to write a requirement you can check

Name the field as it appears in the response: total rather than "final amount". Say how to compare: "equals", "not empty", "not greater than", "equals the sum". Give the value or the formula. Words like "correctly", "properly" or "as usual" do not define a check: behind them is an expectation only the author knows. Ask and write that expectation down.

Hard to check                          Checkable
---------------------------------------------------------------------------
"The order is created correctly"       "Status 201. The id field is not empty"
"The total is calculated correctly"    "The total field equals the sum of
                                          price*qty over all items"
"The status after payment is right"    "The status field equals PAID"
"There are no errors"                  "The orders service log has no
                                          ERROR lines"
"The currency is roubles"              "The currency field equals RUB"

What to check beyond the happy path

The happy path is the smaller part of the requirements. For every required field, check the response without it; for every limit, check the boundary value and a value beyond it. If the requirement does not say which error code to expect, do not pick one yourself: ask the analyst. Separately, write down what happens inside: a journal record, an event, no errors in the logs for the request traceId. A 200 response while a service fails internally is a common reason for "everything is green but it does not work".

Coverage: what is checked and what is not

A list of checks says little until you see which requirement each one covers. Coverage is a "requirement → checks" table. A requirement with no checks is a gap you see at once, and a person decides what to do: clarify it, check it by hand or postpone it. The example below is the actual result of parsing such requirements in Checkcraft: four became checks, one is honestly marked as not parsed because it has neither a field nor a value.

Requirements (POST /api/orders), in Russian in the app:
  Status 201. The status field equals PAID. The total field equals the
  sum of price*qty over all items. The orders service log has no ERROR
  lines. The discount must follow the promotion rules.

Coverage in Checkcraft (labels translated):
  ✓ Status 201                        → status code 201
  ✓ status equals PAID                → status = PAID
  ✓ total equals the sum of price*qty → total = sum of price×qty over items
  ✓ no ERROR lines in the orders log  → log (service orders, level ERROR):
                                         no records expected
  ✗ Not parsed: the discount must follow the promotion rules
      Field not found: give the field name as it appears in the response.

How to do it in Checkcraft

Paste the requirements as text into the Checkcraft AI window together with the request: method and URL, cURL or OpenAPI. The local AI runs on your computer and does not send requirements to external services. Within a minute the checks and the coverage appear on the right: "✓" means the requirement became checks, "✗ Not parsed" is a gap with a hint. You can edit the checks without code, then run them with one button by hand or in CI and get a report with the API response, the logs and the differences. A person decides: the AI drafts, and whoever is responsible for the result accepts the checks.

Limitations

The parser understands requirements with a field and a condition: "equals", "not empty", "not greater than", "equals the sum", "only A or B", "if field = value, then …", "no ERROR in the service log". Rewrite free-form requirements using the table above. The parser works with Russian wording. No tool knows the rules of your promotion or contract: if they are not in the requirements, they are not in the checks either.

Next step

Repeat this on your own API

Checkcraft is a desktop app that saves API response checks without code and shows what did not match. Start with a sample, then use your own sanitized data. Free runs on Windows and Linux with no time limit.

Download FreeDownload and first run

No sign-up or email needed, the archive is ready in a couple of minutes. See the edition limits.

Start with the linked example and compare its result with your own test requirement.

Ask a person

Get help with your first test

Tell us what you want to test or where you got stuck. We can help you start Checkcraft, choose an example and understand your first run. You can ask before downloading.

The Telegram group is public: do not post passwords, tokens or confidential work data. A description of your task is enough to start.

You can also email us support@checkcraft.ru

No account required. We will reply by email. This is a support request, not a newsletter subscription.