API World

Your REST API is great but if your documentation sucks, your customers won't feel the love.    Documentation is often considered only as an afterthought, something separate from the development process. "Are we ready to release? Is the documentation ready? Did somebody check it? - Blank stares" Sounds familiar?    Documentation writing shouldn't be a manual activity decoupled from development. The code has all the information already. You just need to get it out. You need a good documentation generator.    In this talk, we present MireDot - a REST API documentation generator for Java. MireDot excels at the accuracy of the generated documentation. It takes into account complex Java constructs (generics, inheritance) and existing annotations (Jax-RS, Jackson, Javadoc, …) that other generators don't. It requires almost no effort to set up and uses the information that is already present in your source code. Just plug it into your build system and your    documentation rolls out in seconds.