io.github.swagger2markup.internal.utils

Class ExamplesUtil

java.lang.Object

io.github.swagger2markup.internal.utils.ExamplesUtil

public class ExamplesUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExamplesUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	generateRequestExampleMap(boolean generateMissingExamples, PathOperation pathOperation, java.util.Map<java.lang.String,io.swagger.models.Model> definitions, DocumentResolver definitionDocumentResolver, io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder) Generates examples for request
static java.util.Map<java.lang.String,java.lang.Object>	generateResponseExampleMap(boolean generateMissingExamples, PathOperation operation, java.util.Map<java.lang.String,io.swagger.models.Model> definitions, DocumentResolver definitionDocumentResolver, io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder) Generates a Map of response examples

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExamplesUtil

public ExamplesUtil()

Method Detail

generateResponseExampleMap

public static java.util.Map<java.lang.String,java.lang.Object> generateResponseExampleMap(boolean generateMissingExamples,
                                                                                          PathOperation operation,
                                                                                          java.util.Map<java.lang.String,io.swagger.models.Model> definitions,
                                                                                          DocumentResolver definitionDocumentResolver,
                                                                                          io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

Generates a Map of response examples

Parameters:

generateMissingExamples - specifies the missing examples should be generated

operation - the Swagger Operation

definitions - the map of definitions

markupDocBuilder - the markup builder

Returns:

map containing response examples.

generateRequestExampleMap

public static java.util.Map<java.lang.String,java.lang.Object> generateRequestExampleMap(boolean generateMissingExamples,
                                                                                         PathOperation pathOperation,
                                                                                         java.util.Map<java.lang.String,io.swagger.models.Model> definitions,
                                                                                         DocumentResolver definitionDocumentResolver,
                                                                                         io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

Generates examples for request

Parameters:

generateMissingExamples - specifies the missing examples should be generated

pathOperation - the Swagger Operation

definitions - the map of definitions

markupDocBuilder - the markup builder

Returns:

an Optional with the example content