Re:Ask HN: Back-end team does not document their APIs. How d...
by iddogino on Tuesday October 11, 2016 @01:38PM
(#12686583)
I'd argue that this should go the other way around. Your developers should be creating the 'docs' - the API design and boilerplate, before programing it.
If they actually sit down and design the API before setting of to write the code you'll end up with:
(a) the documentation you want.
(b) an API that this designed consistently and consciously.
Would you let your front end developers build something without at least a wire frame / functional design?
[ Parent
| on HN ]
Re:Ask HN: Back-end team does not document their APIs. How d...
by ameesdotme on Tuesday October 11, 2016 @02:04PM
(#12686902)
Good point. How can you build an API if you don't know what data to return anyway? Designing a model is part of the job and could be documentation by itself. Thanks!