Survey Swagger Review
💣 👉🏻👉🏻👉🏻 ALL INFORMATION CLICK HERE 👈🏻👈🏻👈🏻
Sign up or log in to customize your list.
Join Stack Overflow to learn, share knowledge, and build your career.
Sign up with email Sign up Sign up with Google Sign up with GitHub Sign up with Facebook
Connect and share knowledge within a single location that is structured and easy to search.
I am creating a REST Api using Spring boot, and auto generating the swagger documentation in controllers using swagger codegen. However, I am not able to set a description and example for a parameter of type String in a POST request. Here is mi code:
The example property of the @ApiParam has been manually inserted by me, because the codegen was ignoring that part of the yaml (That is another question: why is the editor ignoring the example part?). Here is part of the yaml:
And finally, this is what swagger is showing:
Finally, the dependencies used in build.gradle are the following ones:
So, Question is: Does anybody know how I can set the description and an example of a body parameter using swagger annotations?
I've achieved to change the description using @ApiImplicitParam instead of @ApiParam, but example is still missing:
1,42333 gold badges1515 silver badges2929 bronze badges
In your example you say kambiTransaction is of type String, but your method consumes application/json. That is you want to sent a plain text string (that contains JSON - as shown in the example value) wrapped in JSON? Why don't you create a domain class for kambiTransaction. Swagger will automatically print the class' structure as JSON example. – dpr Jul 16 '18 at 15:41
I would second @dpr. The right way would be to build a model class and use annotation ApiModel on the class and ApiModelProperty on the fields. ApiModelProperty accepts value and example parameters. – Abinash Jul 16 '18 at 19:41
I have similar issue with generating examples for body objects - annotation @Example and @ExampleProperty simply doesn't work for no reason in swagger 1.5.x. (I use 1.5.16)
My current solution is:
use @ApiParam(example="...") for non-body objects, e.g.:
for body objects create new class and annotate fields with @ApiModelProperty(value = " ", example = " "), e.g.:
1,51722 gold badges1414 silver badges2828 bronze badges
32633 silver badges55 bronze badges
Actually the java doc for the example property of the @ApiParam annotation states that this is exclusively to be used for non-body parameters. Where the examples property may be used for body parameters.
which resulted in the following swagger to be generated for the corresponding method:
However this value doesn't seem to be picked up by swagger-ui. I tried version 2.2.10 and the latest 3.17.4, but neither version used the x-examples property of the swagger.
There are some references for x-example (the one used for non-body parameters) in the code of swagger-ui but no match for x-examples. That is this doesn't seem to be supported by swagger-ui at the moment.
If you really need this example values to be present, your best option currently seems to be to change your method's signature and use a dedicated domain type for the body parameter. As stated in the comments already swagger will automatically pick up the structure of the domain type and print some nice information in swagger-ui:
8,39033 gold badges3232 silver badges5555 bronze badges
28533 silver badges1010 bronze badges
Works perfectly, but only for the primitive types. – VadymVL Mar 23 '19 at 20:04
Swagger.v3 Kotlin/Micronaut example:
1,1931212 silver badges1414 bronze badges
If you are using swagger 2.9.2 then Examples are not working there. These annotations are ignored
Try using swagger 3.0.0-Snapshot. You need to change maven dependencies like this:
and change annotation on your Swagger config file to this: @EnableSwagger2WebMvc
11111 silver badge1010 bronze badges
Still ignores examples/value in @ApiParam( value = "A JSON value", examples = @Example(value = @ExampleProperty(mediaType = MediaType.APPLICATION_JSON, value = "{foo: whatever, bar: whatever2}"))) – isobretatel Feb 14 '20 at 19:15
Thanks for contributing an answer to Stack Overflow!
By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy
Blockchain, Cryptocurrency, Financial Technology
IT Recruitment, Recruiting, Technology Staffing
Blockchain, Cryptocurrency, Mobile Application
B2B Sales, Cloud-Based Solutions, Document workflow
To subscribe to this RSS feed, copy and paste this URL into your RSS reader.
site design / logo © 2021 Stack Exchange Inc; user contributions licensed under cc by-sa. rev 2021.3.9.38752
Design & document all your REST APIs in one collaborative platform.
Standardize your APIs with projects, style checks, and reusable domains.
Test and generate API definitions from your browser in seconds.
Generate server stubs and client SDKs from OpenAPI Specification definitions
API editor for designing APIs with the OpenAPI Specification.
Visualize OpenAPI Specification definitions in an interactive UI.
Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale.
The power of Swagger tools starts with the OpenAPI Specification — the industry standard for RESTful API design
Individual tools to create, update and share OpenAPI definitions with consumers
SwaggerHub is the platform solution to support OpenAPI workflows at scale
Swagger offers the most powerful and easiest to use tools to take full advantage of the OpenAPI Specification.
SmartBear is committed to Open Source development.
Create more with us.
Learn More
Test and Document Your APIs With Ease. Try a link or paste a URL and click SEND.
Contact Us
|
+1 617-684-2600 USA
|
+353 91 398300 EUR
|
+61 391929960 AUS
|
Don’t have an account? Sign up here: SwaggerHub | Swagger Inspector
Have an account? Sign in here: SwaggerHub | Swagger Inspector
NestJs Swagger документация. Документация. Обзор возможностей swagger.
java - How can I set a description and an example in Swagger with...
API Documentation & Design Tools for Teams | Swagger
The Girl’s Guide to Swagger Survey
GitHub - viclovsky/swagger-coverage: Tool which generates full picture...
Hd Milf Amateur
Milf Come In Mouth
Strap On Lezbian
Survey Swagger Review
f_auto" width="550" alt="Survey Swagger Review" title="Survey Swagger Review">fl_progressive" width="550" alt="Survey Swagger Review" title="Survey Swagger Review">h_420" width="550" alt="Survey Swagger Review" title="Survey Swagger Review">q_auto" width="550" alt="Survey Swagger Review" title="Survey Swagger Review">w_1000/
