Valid JSON Is Only Half the Output Contract

说明与用途

验证Markdown结构和JSON模式可确保团队之间的数据交换正确。

问题

A response can be valid JSON yet still fail to meet downstream consumer expectations due to missing or misordered sections.

结果

The validator identifies structural and schema violations, allowing teams to fix handoffs before downstream consumption.

工作流

• Define the consumer requirement with a contract file (JSON Schema + Markdown rules).
• Create a handoff document (Markdown + JSON).
• Run output_contracts validate against the contract and handoff files.
• Inspect the validation report for missing sections, ordering issues, or forbidden phrases.
• Correct the handoff based on the report and re‑validate.

证据

Validation exits with status 1 because the fixture violates the contract.

来源

A clean validation returns 0.

来源

The JSON example requires an identifier, a constrained status, an integer count, and a non-empty items array.

来源