springboot-restdoc-swagger

The aim of this project is to put together Swagger UI, Spring REST Docs / AutoRestDoc for great documentation.

Still looking to add

• https://stackoverflow.com/questions/50570827/is-it-possible-to-use-spring-auto-restdocs-with-swagger-springfox
• can I add swagger code snippets https://www.npmjs.com/package/swaggerui-snippets

See

• http://localhost:8080/swagger-ui.html/ for the standard swagger ui
• http://localhost:8080/themed for themed version
• http://localhost:8080/v2/api-docs for the swagger.json file

Tutorials I have used in setting up this project include

• https://www.vojtechruzicka.com/documenting-spring-boot-rest-api-swagger-springfox/

• https://springframework.guru/spring-boot-restful-api-documentation-with-swagger-2/

• https://reflectoring.io/documenting-spring-data-rest-api-with-springfox/

• http://ics.upjs.sk/~novotnyr/blog/2156/create-html-documentation-from-swagger-via-maven

• https://blog.philipphauer.de/rest-api-documentation-swagger-asciidoc/

• https://dzone.com/articles/spring-boot-restful-api-documentation-with-swagger

For the UI theme https://dzone.com/articles/your-own-swagger-ui-on-liberty

HAVE A LOOK AT: https://dzone.com/articles/apiee-an-easy-way-to-get-swagger-on-java-ee https://github.com/swagger-api/swagger-parser https://github.com/conorroche/swagger-doclet http://enunciate.webcohesion.com/

Use Javadoc for REST method and parameter descriptions. springfox/springfox#1691 https://github.com/springfox/springfox-javadoc