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
@ApiParam not working on Interface method declarations #388
Comments
@charleslieferando you're right it doesnt walk the object graph to find the parameter. if you'd like to take a crack at it, it needs to use AnnotationUtils to do the job? would you like to submit a PR? |
thanks for the tip @dilipkrish . I will give it a shot! |
@charleslieferando are you working on this? May i be of your help? |
Changed this to a feature. Its a little harder to implement this |
@dilipkrish Does not work for me in 2.2.2. Descriptions of method parameters by @ApiParam in interface are ignored. If annotations are moved to implementation class, they work. Should I open a bug report? |
Emmmm so what? :) |
It does not work for me either in 2.3.1. |
Any timeline for fixing this? |
@dilipkrish Should @ApiIgnore works in 2.5.0 in the same way? Now I still have a problem with it. I have added @ApiIgnore to a method parameter in an interface, but it is not ignored until I will add it to class. P.S. I have added |
@grined The |
After upgrading from 2.5.0 to 2.6.0 it seems that @ApiParam is ignored again if defined on interface methods. |
@flowerrrr thanks for reporting.. perhaps could you create a new issue with maybe a breaking test? |
Hi! For me @ApiParam doesn't work as well in the version 2.6.1. This is the first version in which I have tried to move swagger annotations out to the interface. |
@flowerrrr & @abryantsev thanks for reporting. I verified and created a new issue for this #1575 |
Has this been fixed? The API doc still does not display descriptions of method parameters defined by @apiparam in the interface. We're using version 2.7.0 |
@dilipkrish I am using version 2.8.0 and still facing same issue. I have also created a new ticket for it #2239 |
@dilipkrish我正在使用2.9.2版,仍然面临相同的问题。 |
sorry ,i find i use error DocumentationType of docket |
Hi guys,
first of all, many thanks for this library. It is an awesome piece of work.
I am having issues with the way @ApiParam is handled by swagger-springmvc (using 0.8.6-SNAPSHOT). My team has decided to add all swagger annotations to an interface which the Controller concrete class implements. When I have something like the following:
the description of the method parameters as specified by @ApiParam is ignored as shown in the screenshot below:
But when I move @ApiParam back to the Controller concrete class (in one of the methods), the descriptions (value property of the @ApiParam annotation) show up properly as shown below:
The problem is that we would really like to keep our Controller classes clean (without any swagger annotations). Do you have some pointers on what I can customize in swagger-springmvc to achieve the effect that the @ApiParam descriptions show up on the swagger UI? Any help or insights would be appreciated.
Best regards,
Charles
The text was updated successfully, but these errors were encountered: