API World has ended
Back To Schedule
Tuesday, September 16 • 9:40am - 10:00am
MireDot - Perfect REST API Documentation in 5 Minutes

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

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.  


Yves Vandewoude

CEO, MireDot
I’m a senior software architect at a Belgian software firm that has developed many large scale multi-tier applications using an agile software approach. Over the 5 years, REST interfaces and public APIs have become increasingly dominant in this domain and my colleagues and I have... Read More →

Bert Vanhooff

CTO, Qmino
I've been developing webapplications and webservices since before it was cool (SOAP). In the last 5 years I've architected and implemented dozens of REST APIs, mainly using Java/Spring/Hibernate. Recently I started trying Scala/Spray. I'm also passionate about front-end/design and... Read More →

Tuesday September 16, 2014 9:40am - 10:00am PDT
Hotel Kabuki

Attendees (0)