Skip to content

README.md

Latest commit

 

History

History
50 lines (33 loc) · 1.77 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.77 KB

Generation of OpanAPI specification based on Spring REST Controllers.

Maven project with an example how the OpenAPI spec can be generated based on implementation. It provides also the information on how static documentation can be generated based on the spec.

Example based on springdoc

Run the application

  • Run application using mvn spring-boot:run -Pspringdoc
  • Open http://localhost:8080/swagger-ui.html in browser

Generate OpenAPI description in json

  • Run application using mvn install -Pspringdoc
  • Output file is in target/openapi.json

HTML document generation based on OpenAPI spec

Example made with help of ReDoc

HTML doc generated for this project redoc-example

Prerequesites

  • Install Node.js
  • Install redoc-cli. Run npm install -g redoc-cli

Generate documentation

  • Generate openapi.json for the project
  • Run redoc-cli bundle target/openapi.json --options.hideHostname=true
  • Open redoc-static.html in browser

Markdown document generation based on OpenAPI spec

Example made with help of widdershins

MD doc generated for this project widdershins-example

Prerequesites

  • Install Node.js
  • Install widdershins. Run npm install -g widdershins

Generate documentation

  • Generate openapi.json for the project
  • Run node widdershins --search false --language_tabs 'java:Java' --summary target/openapi.json -o doc/widdershins-static.md
  • Open doc/widdershins-static.md in markdown viewer.

PDF document generation based on OpenAPI spec

Example made with help of RapiPdf

Open doc/RapiPDF.html in browser and click GENERATE PDF.