3 ms·
It might be nice if this was described in an existing data format (YAML, anyone) as a particular form of structure, rather than inventing a new data format.
by mpdehaan2 11y ago
It might be nice if this was described in an existing data format (YAML, anyone) as a particular form of structure, rather than inventing a new data format.
- pksunkara 11y agoWhat do you think about API Blueprint [1]? It is based on Markdown. [1]: https://apiblueprint.org https://apiblueprint.org
- mpdehaan2 11y agoI think Markdown is generally unsuitable as a data format for machines. YAML strikes a nice balance between machines and people, but I wouldn't want to write a blog post in it. Markdown is great for blog posts, but APIs are terse.
- rlevy 11y agoRAML is essentially a YAML with a specific schema. Tell your IDE to treat .raml files as .yaml and all the syntax highlighting, etc will work perfect
- mpdehaan2 11y agoAh, that makes a lot more sense then. It appeared to have weirdness from the homepage: - secured: !include http://remote-host/secured.yml /songs: Which is invalid YAML. It turns out this is probably an unfortunate word-wrap in the page, where a non-wrapping text field would better convey the format.