1 year ago

#354433

test-img

Doctor_Sidious

JavaDocs for SpringBoot REST API or other known Architectures/Frameworks? Necessary?

After creating a SpringBootApp to supply REST Services, all according to official Spring Documentation but adding a Service Layer (who knows why Spring Docs ignores this), I've consider creating JavaDocs for the project.

Problem is... It's too redundant and all the effort would imply to explain explicit methods and classes like "Controller Method that provides GET service..." when the class is called Controller and method has @GetMapping tag. If official documentation is on the internet and you respected Arquitectural Design Patterns, why should you redo all the work that somebody has already done? I mean, if it was something purely original and imposible to understand, of course I would have to document everything till the most minuscule detail: but for this? Not sure...

What do you think? Am I being a lazy programmer or could you justify this lack of effort?

java

spring-boot

rest

documentation

javadoc

0 Answers

Your Answer

Accepted video resources