CODEWITHSUNDEEP
spring-mvcswagger
Reezy
Reezy

Reputation: 984

Springfox Spring Web MVC endpoint description

I'm using Springfox in a Spring Web MVC project, without any of the custom Springfox/Swagger annotations. In Swagger UI (and of course in the JSON that is generated), the description for the endpoints are just the method names.

Is there any way of automatically using the description as it is in the code comment (which is a properly formatted Javadoc styled comment).

Upvotes: 0

Views: 486

Answers (1)

Robert Winkler
Robert Winkler

Reputation: 1907

In Swagger2Markup you can write descriptions in AsciiDoc and combine the hand-written documentation with your generated documentation.

I plan to integrate https://github.com/asciidoctor/asciidoclet into Swagger2Markup.

Upvotes: 0

Related Questions