Swagger › Integrating swagger with Spring 3.2 MVC - without @Api annotations

471 views
Skip to first unread message

Med Marouane Ajraoui

unread,
Jul 22, 2015, 6:22:16 AM7/22/15
to Swagger
Hi all,
 
I have an existing rest "Spring 3.2 MVC" API, and I would like to automatize REST API documentation generation. 
Swagger seems like the right tool to integrate with Spring MVC.

The question here is:
Is it possible to generate documentation, without @Api swagger annotations?
In other words, does Swagger support documentation generation, based only on Spring MVC annotations: @controller, @RequestMapping, @ResponseBody, @RequestParam, @Controller?

Thank you in advance for sharing any info,

Marouane

Ron Ratovsky

unread,
Jul 22, 2015, 6:31:44 AM7/22/15
to swagger-sw...@googlegroups.com
You can check the documentation for https://github.com/springfox/springfox if they provide that option.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.



--
-----------------------------------------
http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

Med Marouane Ajraoui

unread,
Jul 22, 2015, 11:41:28 AM7/22/15
to Swagger
Thank you Ron for your answer.
In the architecture overview part of the springfox project documentation, it is mentioned that there is a module "springfox-spring-web" which can build the service models based on RequestMapping. But how? Documentation is not clear. Definitely, this project will be more useful for the community if an effort on documenting clearly HOW TOs is carried on. I have download the demo projects, but no relevant/clear info.
Any resources or doc are welcom.
Thanks in advance for sharing.

Marouane

Dilip Krishnan

unread,
Jul 22, 2015, 8:49:20 PM7/22/15
to Swagger
The Latest documentation is available here -> http://springfox.github.io/springfox/docs/current/ not sure if you had a chance to take a look at that. It's fairly comprehensive, there is only so much to document. Also the demo applications serve as an example. If you have any questions the gitter channel is always open :)

Marouane AJRAOUI

unread,
Jul 23, 2015, 4:21:49 AM7/23/15
to swagger-sw...@googlegroups.com
Thank you very much Dilip.


2015-07-23 2:49 GMT+02:00 Dilip Krishnan <dilip.k...@gmail.com>:
The Latest documentation is available here -> http://springfox.github.io/springfox/docs/current/ not sure if you had a chance to take a look at that. It's fairly comprehensive, there is only so much to document. Also the demo applications serve as an example. If you have any questions the gitter channel is always open :)

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/mLwf0AGt3z0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.



--
Marouane
Reply all
Reply to author
Forward
0 new messages