Press "Enter" to skip to content

Tag: spring

Documenting Spring Boot REST services

Documentation is important, everybody knows this, especially when you are the one who needs to use some third party service or library. Without good documentation it’s often a living hell, it’s like walking through a minefield. You carefully take step after step, praying that things won’t blow up. That’s why you HAVE to create documentation, especially for your libraries and REST services. Another important thing about documentation is that you have to update it whenever code changes because the only worse thing than no documentation is wrong documentation, a documentation that is not valid for the current code base.

So if everybody knows about this, it should be ok, right? Wrong. Developers hate creating documentation and they do not do it unless it is really necessary or someone makes them do it – and unfortunately that statement is also true for me. Creating documentation is not bad, but maintaining it, may be hard, especially when you have a critical bug after bug to fix, and deadlines closing in – you just don’t have time to do it.

But there is hope… you can generate it!

Continue reading Documenting Spring Boot REST services