Why YAML?
Many API tools use JSON to save collections. Heapi made a different design decision: YAML.
Git-Friendly
The biggest benefit is how YAML behaves in version control systems like Git.
- Readable Diffs: In JSON, a forgotten comma breaks everything and diffs are usually messy. In YAML, every line is clear.
- Merge Conflicts: It's much easier to resolve a conflict in a YAML file than in a massive JSON file where everything is in a single bracket tree.
Comments and Multi-line
YAML allows adding comments directly in the file and handles multi-line strings (like a request body) much more naturally, without needing thousands of \n escapes.
Treat your API as code. With Heapi, your YAML collection lives right alongside your source code in Git.