Can jsondoc understand spring annotation, like @RequestBody and @PathVariable?

[volyx]

Can jsondoc understand spring annotation?

If it can, i remove @ApiBodyObject annotation.

[fabiomaffioletti]

It does can understand spring's annotations, but it's has an "opt-it" strategy, meaning that you still need to put jsondoc annotations to decide what you would like to document and what not.

[bedge]

Would it be possible to have a more global flag to eliminate the need to explicitly add annotations for everything? Maybe a file or package scope flag?
Would save on a lot of annotation typing.

[volyx]

Yes, it will be good.
I interested in such case:
If I mark method with annotation @apimethod i mean that this method will be available in jsondoc with all parameters. Maybe we can define any flag only for jsondoc-springmvc module?
It will be good especially for small projects.

[fabiomaffioletti]

The good thing about jsondoc is that it is framework agnostic, meaning that you can put its annotation on anything you want (you can even annotate non-controller and non-dto classes and have the doc and playground generated and working properly). To do that I needed to require the "technical writer" to decide what to document, this is the reason behind the "annotate everything" approach. But you are right, @apimethod would be enough, in case you are for example annotating a spring controller. Changing that in this moment would mean a lot of work though, which I cannot afford right now.

[rajiv-shringi-A1]

+1 for this enhancement. The opt-in approach can be controlled by a package level global flag (example: if the flag is true for a given package, then you have to opt in and explicitly annotate in order to generate documentation for the controllers in that package). But that should be only for annotations @Api and/or @apimethod. I believe the @ApiPathParam, @ApiRequestBody annotations are redundant. The @PathVariable and @RequestBody annotations should be enough for generating playground.