Please enable JavaScript.
Coggle requires JavaScript to display documents.
Java REST Documentation Frameworks - Coggle Diagram
Java REST Documentation Frameworks
Swagger - OpenAPI
Generates everything automatically
Components
Swagger: The specification
Swagger 1.0 => 2011
Swagger 1.1 => 2012
Swagger 2.0 => 2014
4. OpenAPI 3.0 => 2015
Swagger UI: The rendering part.
Creates a user friendly html and testing tool
Springfox: The generation part.
Interacts with the annotations (spring or springfox) and
generates the documentation
(+) Generation on runtime, so there is no need to add extra build steps
(-) Since everything is auto-generated, we don't have so much control
RAML
Documentation on a different file alongside with project
Manual maintenance
Tools
API workbench
RAML Java Client Generator
RAML2HTML
Spring REST Docs
Part of Spring ecosystem
Generates AsciiDoc snippets (how to call the endpoint) based on unit tests (Spring MVC Test)
It's not dedicated to the browser. So, it can be used with any testing tool
Serves an extra sanity test for your code
Why to choose
Can be part of integration tests
We can combine it with other documents