A B C D F G I L M N O P R S T V W

A

accept(T) - Method in interface io.github.robwin.swagger2markup.utils.Consumer

The function itself

asString() - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter

Builds the document with the given markup language and returns it as a String

B

build() - Method in class io.github.robwin.swagger2markup.builder.document.DefinitionsDocument

build() - Method in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

Builds the MarkupDocument.

build() - Method in class io.github.robwin.swagger2markup.builder.document.OverviewDocument

Builds the MarkupDocument.

build() - Method in class io.github.robwin.swagger2markup.builder.document.PathsDocument

Builds the paths markup document.

build() - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

C

Consumer<T> - Interface in io.github.robwin.swagger2markup.utils

Java 8 style Consumer functional interface

CONSUMES - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

convertTagsListToMap(List<Tag>) - Static method in class io.github.robwin.swagger2markup.utils.TagUtils

Converts the global Tag list into a Map where the tag name is the key and the Tag the value.

D

DEFAULT_COLUMN - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

DefinitionsDocument - Class in io.github.robwin.swagger2markup.builder.document

DefinitionsDocument(Swagger2MarkupConfig, String) - Constructor for class io.github.robwin.swagger2markup.builder.document.DefinitionsDocument

DELIMITER - Static variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

DESCRIPTION - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

DESCRIPTION_COLUMN - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

F

from(String) - Static method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter

Creates a Swagger2MarkupConverter.Builder using a given Swagger source.

from(Swagger) - Static method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter

Creates a Swagger2MarkupConverter.Builder from a given Swagger model.

fromString(String) - Static method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter

Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.

G

getDefaultValue(Parameter) - Static method in class io.github.robwin.swagger2markup.utils.ParameterUtils

Retrieves the default value of a parameter, or otherwise an empty String

getDefaultValue(Property) - Static method in class io.github.robwin.swagger2markup.utils.PropertyUtils

Retrieves the default value of a property, or otherwise returns an empty String.

getDefinitionsOrderedBy() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getDescriptionsFolderPath() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getExamplesFolderPath() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getMarkupLanguage() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getOutputLanguage() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getPathsGroupedBy() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getSchemasFolderPath() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getSwagger() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

getTagDescription(Map<String, Tag>, String) - Static method in class io.github.robwin.swagger2markup.utils.TagUtils

Retrieves the optional description of a tag.

getType(Model, MarkupLanguage) - Static method in class io.github.robwin.swagger2markup.utils.ModelUtils

Retrieves the type of a model, or otherwise "NOT FOUND"

getType(Parameter, MarkupLanguage) - Static method in class io.github.robwin.swagger2markup.utils.ParameterUtils

Retrieves the type of a parameter, or otherwise an empty String

getType(Property, MarkupLanguage) - Static method in class io.github.robwin.swagger2markup.utils.PropertyUtils

Retrieves the type and format of a property.

GroupBy - Enum in io.github.robwin.swagger2markup

groupPathsByTag(Map<String, Path>) - Static method in class io.github.robwin.swagger2markup.utils.TagUtils

Groups the paths by tag.

I

intoFolder(String) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter

Builds the document with the given markup language and stores the files in the given folder.

io.github.robwin.swagger2markup - package io.github.robwin.swagger2markup

io.github.robwin.swagger2markup.builder.document - package io.github.robwin.swagger2markup.builder.document

io.github.robwin.swagger2markup.config - package io.github.robwin.swagger2markup.config

io.github.robwin.swagger2markup.utils - package io.github.robwin.swagger2markup.utils

isSeparatedDefinitions() - Method in class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

L

Language - Enum in io.github.robwin.swagger2markup

logger - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

M

markupDocBuilder - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

MarkupDocument - Class in io.github.robwin.swagger2markup.builder.document

markupLanguage - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

ModelUtils - Class in io.github.robwin.swagger2markup.utils

ModelUtils() - Constructor for class io.github.robwin.swagger2markup.utils.ModelUtils

N

NAME_COLUMN - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

O

OrderBy - Enum in io.github.robwin.swagger2markup

OverviewDocument - Class in io.github.robwin.swagger2markup.builder.document

OverviewDocument(Swagger2MarkupConfig) - Constructor for class io.github.robwin.swagger2markup.builder.document.OverviewDocument

P

ParameterUtils - Class in io.github.robwin.swagger2markup.utils

ParameterUtils() - Constructor for class io.github.robwin.swagger2markup.utils.ParameterUtils

PathsDocument - Class in io.github.robwin.swagger2markup.builder.document

PathsDocument(Swagger2MarkupConfig) - Constructor for class io.github.robwin.swagger2markup.builder.document.PathsDocument

preProcessSwagger(Consumer<Swagger>) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Customize the Swagger data in any useful way

PRODUCES - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

PropertyUtils - Class in io.github.robwin.swagger2markup.utils

PropertyUtils() - Constructor for class io.github.robwin.swagger2markup.utils.PropertyUtils

R

REQUIRED_COLUMN - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

S

SCHEMA_COLUMN - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

swagger - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

Swagger2MarkupConfig - Class in io.github.robwin.swagger2markup.config

Swagger2MarkupConfig(Swagger, MarkupLanguage, String, String, String, boolean, GroupBy, OrderBy, Language) - Constructor for class io.github.robwin.swagger2markup.config.Swagger2MarkupConfig

Swagger2MarkupConverter - Class in io.github.robwin.swagger2markup

Swagger2MarkupConverter.Builder - Class in io.github.robwin.swagger2markup

T

TAGS - Variable in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

TagUtils - Class in io.github.robwin.swagger2markup.utils

TagUtils() - Constructor for class io.github.robwin.swagger2markup.utils.TagUtils

toLocale() - Method in enum io.github.robwin.swagger2markup.Language

toString() - Method in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

Returns a string representation of the document.

V

valueOf(String) - Static method in enum io.github.robwin.swagger2markup.GroupBy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.github.robwin.swagger2markup.Language

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.github.robwin.swagger2markup.OrderBy

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.github.robwin.swagger2markup.GroupBy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.github.robwin.swagger2markup.Language

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.github.robwin.swagger2markup.OrderBy

Returns an array containing the constants of this enum type, in the order they are declared.

W

withDefinitionsOrderedBy(OrderBy) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Specifies if the definitions should be ordered by natural ordering or stay as-is.

withDescriptions(String) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Include hand-written descriptions into the Paths and Definitions document

withExamples(String) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Include examples into the Paths document

withMarkupLanguage(MarkupLanguage) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Specifies the markup language which should be used to generate the files

withOutputLanguage(Language) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Specifies labels language of output files

withPathsGroupedBy(GroupBy) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Specifies if the paths should be grouped by tags or stay as-is.

withSchemas(String) - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

Include (JSON, XML) schemas into the Definitions document

withSeparatedDefinitions() - Method in class io.github.robwin.swagger2markup.Swagger2MarkupConverter.Builder

In addition to the definitions file, also create separate definition files for each model definition.

writeToFile(String, String, Charset) - Method in class io.github.robwin.swagger2markup.builder.document.MarkupDocument

Writes the content of the builder to a file and clears the builder.

A B C D F G I L M N O P R S T V W