Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support "summary" field for ApiOperations #6

Open
metacubed opened this issue May 15, 2018 · 1 comment
Open

Support "summary" field for ApiOperations #6

metacubed opened this issue May 15, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@metacubed
Copy link

metacubed commented May 15, 2018

The Swagger 2.0 spec supports two fields on @ApiOperation: "summary" and "notes". In the current implementation, we set only the "notes" using the entire value of the comment.

However, the Javadoc spec also supports a summary and a description. From the Javadoc tech notes:

First Sentence
The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The javadoc command copies this first sentence to the member summary at the top of the HTML page.

Using this spec, we can provide both "summary" and "notes" for @ApiOperation. It can also be used on class docs to specify @Api "tags".

@dilipkrish, do you think this is a good approach? I can help with implementing this if you don't foresee any issues.

@neumaennl
Copy link

Hi, I'm one of the original authors of springfox-javadoc. I just had to delete my company account because I no longer work for the company. This is my private account.
This sounds like a good idea to me. I'd say go ahead and submit a pull request.

@neumaennl neumaennl added the enhancement New feature or request label May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants