1

Is it possible to use spring-auto-restdocs with Swagger/SpringFox, swagger2markup?

I'd like to: - Use Swagger/SpringFox to provide the test area BUT then I want the examples in that UI to be similar to what - spring-restdoc does to provide the sample code snippets AND - Use spring-auto-restdocs to get the documentation from POJO that represents your JSON object, by just adding Javadoc to the fields and not the swagger annotations

Melissa
  • 812
  • 2
  • 10
  • 24

1 Answers1

1

I see no simple way of achieving this. Without using any Swagger code (either annotations or the SpringFox DSL), SpringFox or swagger2markup are not very useful. If you have both Swagger annotations and Spring (Auto) REST Docs, it might be possible to include the AsciiDoc snippets generated by Spring (Auto) REST Docs into the AsciiDoc used for swagger2markup. AsciiDoc supports including other AsciiDoc files and this feature is also used when including the Spring REST Docs snippets into hand-written documentation.

I looked into generating a Swagger/OpenAPI files out of REST Docs snippets and wrote a guide on how to do so https://github.com/fbenz/restdocs-to-swagger However, it is a combination of tools rather than a simple integration. Furthermore, the field and method documentation does not make it into the Swagger files/UI.

Florian Benz
  • 422
  • 4
  • 11
  • 1
    Thanks Florian, I have seen a couple tutorials merging SpringFox or swagger2markup and Spring REST Doc, and have done this, using these tutorials - in the following repo: https://github.com/melissapalmer/springboot-restdoc-swagger I have seen you rest-docs-swagger and tried it out thank you BUT like you say its a combination of tools and the swaggymnia does not look like its being maintained. Issue https://github.com/mlabouardy/swaggymnia/issues/9. Hence I believe a combination of Swagger/SpringFox, swagger2markup and your spring-auto-restdocs seems like a good way to go. – Melissa May 29 '18 at 14:59