3 ms·
Also, if you follow REST closely your APIs should be self documenting.
by MatthewPhillips 14y ago
Also, if you follow REST closely your APIs should be self documenting.
- mattetti 14y agoI have yet to see a REST interface that self describes in details its incoming params and output. REST gives you discoverability which is different from documentation.
- jrochkind1 14y agoPlus, it's actually really HATEOS that gives you discoverability, not just any old REST. But either way, I agree with you, while the theory is that if you do it 'right' one way or another it's self-documenting, I have yet to see an API which doesn't need good documentation to be usable. Well, actually, that's a lie, I've seen at least one: The TinyURL "api". Which is obviously extremely simple.