@ApiOperation document with long detailed description

Question

When documenting an operation using @ApiOperation, an attribute exists notesfor a detailed description of the operation. But adding a long description to the annotations makes it cumbersome and difficult to implement.

Is there a more elegant option for linking to an external file or something else?

Answer 1

Not now, no. In the best case, I could recommend using a string constant as an input to @ApiOperationand store it elsewhere to avoid clutter. Another option would be to use external documents if you are using swagger-core 1.5.