3 ms·
I'd suggest RAML for pure documentation. Its way of structuring resources is nested with the URI, so UI generators can use that information to group together in
by cshenton 10y ago
I'd suggest RAML for pure documentation. Its way of structuring resources is nested with the URI, so UI generators can use that information to group together in the docs.
Also it supports union types for request/resp. Which means that you can template a URI and have multiple response schemas to go with different values of the template. Unlike swagger which forces you to enumerate every endpoint if you want them to have different response schemas, which is very ugly for logically grouped sets of resources which aren't explicitly part of a collection.
- lobster_johnson 10y agoAre there any UI generators for it that are worth mentioning, with the sentiments in my other comment [1] in mind? [1] https://news.ycombinator.com/item?id=13927657 https://news.ycombinator.com/item?id=13927657