The plugin is good but could be better with following features:
Ability to describe service class and methods - At the moment there is no way to add description for the generated Service class and methods. We have home grown swagger generation tool that does what we need but takes a longer route of first generating javadoc, then generating WADL and then generating swagger. By doing this we are able to pick up the java doc at the method level and add it as description in the generated definition. We don't mind adding swagger annotations like below if that could be used as standardization:
At Class Level: @Api(value = "customers", description = "RESTful API to interact with application resources.")
At Method Level: @ApiOperation(value = "Update Application Status", notes = "Update application status for the given application id", responseContainer = "", response = Boolean.class)
All of our service methods return a wrapper object with actual response composed in that wrapper. When swagger definition is created it would be great if we could link actual object that would be composed in the wrapper. At the moment we do this by declaring javadoc as follows: @return WrapperResponse - {@link com.sample.platform.booking.entity.BookApplication com.sample.platform.booking.entity.BookApplication}
Give option to select only finite set of URIs that have to be generated in the final swagger file. We have a file called include-rest-api.txt where the service URIs could be specified and the swagger generated will only have those many definitions.
The plugin is good but could be better with following features:
Ability to describe service class and methods - At the moment there is no way to add description for the generated Service class and methods. We have home grown swagger generation tool that does what we need but takes a longer route of first generating javadoc, then generating WADL and then generating swagger. By doing this we are able to pick up the java doc at the method level and add it as description in the generated definition. We don't mind adding swagger annotations like below if that could be used as standardization: At Class Level: @Api(value = "customers", description = "RESTful API to interact with application resources.") At Method Level: @ApiOperation(value = "Update Application Status", notes = "Update application status for the given application id", responseContainer = "", response = Boolean.class)
All of our service methods return a wrapper object with actual response composed in that wrapper. When swagger definition is created it would be great if we could link actual object that would be composed in the wrapper. At the moment we do this by declaring javadoc as follows: @return WrapperResponse - {@link com.sample.platform.booking.entity.BookApplication com.sample.platform.booking.entity.BookApplication}
Give option to select only finite set of URIs that have to be generated in the final swagger file. We have a file called include-rest-api.txt where the service URIs could be specified and the swagger generated will only have those many definitions.