How can I use swagger api functionality to generate response example

Question

I am working on a project where I have to generate json representation of method return type.
I have seen swagger api is generating response example and wanted to know, how can I use swagger api functionality to generate response example and use it internally.
Any help would be highly appreciated.
Thanks

hkosova · Answer

Hi rajrahul9939,
&nbsp;
Just to clarify - do you want to generate an example of JSON payload based on a schema definition? Or do you need a mock server that would return sample responses? Or something else?

rajrahul9939 · Answer

Hi&nbsp;&nbsp;HKosova&nbsp;Thank you for your response.I wanted to generate an&nbsp;example of JSON payload based on a method return type, same as swagger generate the response example.&nbsp;Thank you

hkosova · Answer

You can use the Swagger Inflector Java library, specifically its ExampleBuilder class, to generate JSON examples. Here's sample code:
https://stackoverflow.com/questions/41408768/how-to-generate-json-examples-from-openapi-swagger-model-definition

rajrahul9939 · Answer

Hey&nbsp;HKosova&nbsp;swagger-inflector, only works when the schema is defined, Here is more details about my query.I have an API "/hello" defined below.and Person class like below.I wanted to generate a response example like below.Thank you.

rajrahul9939 · Answer

Hey&nbsp;HKosova ,could you please help&nbsp;

Forum Discussion

How can I use swagger api functionality to generate response example

6 Replies

Recent Discussions

Use anyOf/oneOf with codegen?

Hiding one of multiple routes for an endpoint - Swagger c# .net 4.8

How to customize the swagger-editor to include other definitions besides the PetStore

Related Content

Generate JSON Schemas

How to access Main Function Name in General Events

Execute Scenario from AfterFeature function