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

Generate description based on method name. #175

Closed
magdenkov opened this Issue Jan 8, 2016 · 1 comment

Comments

Projects
None yet
2 participants
@magdenkov

magdenkov commented Jan 8, 2016

For example given Spring mvc with spring boot
@RequestMapping(value = "/project/{id}",
method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity getProjectById(@PathVariable("id") String id) { }

Than will be generated
/* Get project by id */
/project/{id} GET

So no addiitional annotations like @ApiMethod (description =" ") will be needed at all.
Selfdocumented code)

@fabiomaffioletti fabiomaffioletti added this to the 1.2.12 milestone Apr 14, 2016

@fabiomaffioletti fabiomaffioletti self-assigned this Apr 14, 2016

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Apr 14, 2016

Owner

Sounds good, but instead of putting that value in the description I added another MethodDisplay called METHOD that uses the method name instead of the URI / SUMMARY. I like the idea of a self documented approach, but I prefer to leave the description field as free as possible.

Owner

fabiomaffioletti commented Apr 14, 2016

Sounds good, but instead of putting that value in the description I added another MethodDisplay called METHOD that uses the method name instead of the URI / SUMMARY. I like the idea of a self documented approach, but I prefer to leave the description field as free as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment