The API Lab
Join the DZone community and get the full member experience.Join For Free
promotion is a problem faced by every api developer. long nights of coding have given form to the stroke of genius you had six months ago in the cafe. you’ve just written the api that will serve as the front door into your application. but how do you document this so that your peers will use it—and hopefully make you rich in the process?
java had javadoc, an innovation that managed to strike a surprisingly effective balance between ease of use and systematization (three cheers for strong typing and static binding). web services “solved” the interface definition problem with wsdl , a standard only its authors could love (and some of these won’t admit to participating in conception). to the registry crowd was left the task of devising clever ways to document a soap api around the torturous abstractions of wsdl so that humans could grok it as effectively as the machines. few would argue that their solutions were, well, solutions.
restful apis neither benefit nor suffer from formalized approach and automation. every so often wadl pokes its head up, only to be knocked decisively back into its hole in a community game of standards- whac-a-mole. rest is—and indeed, has always been—a style that resists any formalism that threatens its simplicity and accessibility. for this, above all, the community deserves praise.
but this does leave a hole around documentation. apis tend to be described-by-wiki, which can be great or just awful, depending on a developer’s ability to write and discipline to update. good ideas like programmableweb showcase both of these extremes; however, the site suffers in particular from out-of-date api descriptions which is too bad.
outside of the eventual acceptance en masse of some kind of standardized wiki template for apis (which i think is actually quite likely), we probably won’t see substantial change in api documentation soon. minor changes, though, can still count for a lot, and it’s worth pointing these out.
google, always an innovator to watch, create a lot of apis. they recently published the periodic table of google apis , which as its name suggests is a clever way to visually categorize their api portfolio into groups like mobile, data, geo, etc. it’s a bit gimmicky, but it is also fun and actually inspired me to try some new google apis that i wasn’t aware of before.
so, isn’t it about time for more creative solutions around api documentation?
Published at DZone with permission of Scott Morrison . See the original article here.
Opinions expressed by DZone contributors are their own.