4 ms·
the interface you establish is the ultimate form of communication with the people behind the clients. You can't force people to read/obey documentation (no matt
by AffableSpatula 14y ago
the interface you establish is the ultimate form of communication with the people behind the clients. You can't force people to read/obey documentation (no matter how pretty or up-to-date it is), but they are obliged (naturally) to follow the rules of your interface.
It's also worth bearing in mind that the design you pick will directly affect how you document your API - documentation of RPC APIs are different from that of Rails-style CRUD-over-HTTP APIs, which in turn are different from that of REST APIs (or "hypermedia APIs" - redundant term, really).
- MatthewPhillips 14y agoAlso, 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.
- mattetti 14y agoI fully agree, the point that I'm trying to make is that there is a step in between you offering an API and people using it. Explicitly defining your interface will make the transition easier for 3rd party developers.