Howto add resource description using 1.5 @Api annotation
See original GitHub issueI’m currently in the process of updating from 1.3 to 1.5.
While most things are working now, I was unable to figure out how to set the description of a resource using the @Api
annotation in 1.5. With 1.3 I was using
@Api(value = "My Swagger Resource", description = "Meaningful stuff in here")
For 1.5 I modified this to
@Api(tags = { "My Swagger Resource" }, description = "Meaningful stuff in here")
But the description attribute is deprecated and obviously not used anymore. I already tried to find examples on how to set this using the tags
but was unable to find any resources on this.
I assume adding a resource description is still possible in 1.5, but how?
Issue Analytics
- State:
- Created 7 years ago
- Comments:5 (1 by maintainers)
Top Results From Across the Web
Api (swagger-annotations 1.5.0 API)
Annotation Type Api ... Marks a class as a Swagger resource. By default, Swagger-Core will only include and introspect only classes that are...
Read more >Swagger 1.5 Doesn't Display My 1.2's @Api Description?
One can add tags or enhance existing ones by programmatically apply the @Tag annotation to any resource discoverable by Swagger.
Read more >Swagger @Api Description Is Deprecated - Baeldung
One common tool used to document REST APIs is Swagger 2. However, one useful attribute used for adding a description has been deprecated....
Read more >29.2 Creating a RESTful Root Resource Class
Resource methods are methods of a resource class annotated with a request method designator. This section explains how to use JAX-RS to annotate...
Read more >Spring HATEOAS - Reference Documentation
Find more information on how to create links pointing to Spring MVC and Spring ... you can use the @NonComposite annotation with the...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@dpr-rec but it’s not working for me.
How to add in this can anyone help me ?