API debugging workflow

API Debugging Checklist

Track the exact steps of an API debugging session: request shape, authentication, headers, payload, schema, logs, retry behavior and the final fix notes.

Read debugging guide Open schema generator

Incident notes

Stored locally in this browser

Issue title Endpoint

Method Status

Expected behavior Observed behavior Evidence and reproduction notes

Checklist

Ready

HTTP Status CodesInterpret response codes HTTP HeadersCheck auth, CORS and cache JSON FormatterClean request payloads JSON Schema GeneratorInfer payload contracts Timestamp ConverterNormalize log times JWT DecoderInspect auth claims

Reference notes

A repeatable API debugging flow

Start with the contract

Before changing code, confirm the expected method, route, payload shape, authentication model and response schema.

Separate symptoms from causes

Status codes, request IDs and logs are evidence. The checklist keeps them visible so the investigation does not become guesswork.

Keep sensitive data out

Write sanitized samples and redact secrets. Formalint stores notes locally in the browser, but production credentials still do not belong in any web tool.