Payara Micro Revealed: Cloud-Native Application Development with Java

© The Author(s), under exclusive license to APress Media, LLC, part of Springer Nature 2022

D. R. HeffelfingerPayara Micro Revealedhttps://doi.org/10.1007/978-1-4842-8161-1_10

10. Documenting Web Services

David R. Heffelfinger¹  

(1)

Fairfax, VA, USA

 

Code documentation is an arduous, often thankless task; for this reason, documentation can easily become obsolete and out of date, as changes are made to the code base; in many occasions, documentation is not updated to reflect the latest changes.

Payara Micro can alleviate this problem via its support for the MicroProfile OpenAPI, which makes generating documentation trivial; in many cases, documentation is updated automatically as the code is updated; for example, adding a new parameter to an existing ...