io.github.swagger2markup

Class Swagger2MarkupConverter

java.lang.Object

io.github.swagger2markup.Swagger2MarkupConverter

public class Swagger2MarkupConverter
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Swagger2MarkupConverter.Builder
static class	Swagger2MarkupConverter.Context

Constructor Summary

Constructors

Constructor and Description
Swagger2MarkupConverter(Swagger2MarkupConverter.Context context)

Method Summary

Modifier and Type	Method and Description
static Swagger2MarkupConverter.Builder	from(java.nio.file.Path swaggerPath) Creates a Swagger2MarkupConverter.Builder using a local Path.
static Swagger2MarkupConverter.Builder	from(java.io.Reader swaggerReader) Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON reader.
static Swagger2MarkupConverter.Builder	from(java.lang.String swaggerString) Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
static Swagger2MarkupConverter.Builder	from(io.swagger.models.Swagger swagger) Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
static Swagger2MarkupConverter.Builder	from(java.net.URI swaggerUri) Creates a Swagger2MarkupConverter.Builder from a URI.
static Swagger2MarkupConverter.Builder	from(java.net.URL swaggerURL) Creates a Swagger2MarkupConverter.Builder using a remote URL.
Swagger2MarkupConverter.Context	getContext() Returns the global Context
void	toFile(java.nio.file.Path outputFile) Converts the Swagger specification the given outputFile.
void	toFileWithoutExtension(java.nio.file.Path outputFile) Converts the Swagger specification the given outputFile.
void	toFolder(java.nio.file.Path outputDirectory) Converts the Swagger specification into the given outputDirectory.
void	toPath(java.nio.file.Path outputPath) Converts the Swagger specification into the outputPath which can be either a directory (e.g /tmp) or a file without extension (e.g /tmp/swagger).
java.lang.String	toString() Builds the document returns it as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

Swagger2MarkupConverter

public Swagger2MarkupConverter(Swagger2MarkupConverter.Context context)

Method Detail

from

public static Swagger2MarkupConverter.Builder from(java.net.URI swaggerUri)

Creates a Swagger2MarkupConverter.Builder from a URI.

Parameters:

swaggerUri - the URI

Returns:

a Swagger2MarkupConverter

from

public static Swagger2MarkupConverter.Builder from(java.net.URL swaggerURL)

Creates a Swagger2MarkupConverter.Builder using a remote URL.

Parameters:

swaggerURL - the remote URL

Returns:

a Swagger2MarkupConverter

from

public static Swagger2MarkupConverter.Builder from(java.nio.file.Path swaggerPath)

Creates a Swagger2MarkupConverter.Builder using a local Path.

Parameters:

swaggerPath - the local Path

Returns:

a Swagger2MarkupConverter

from

public static Swagger2MarkupConverter.Builder from(io.swagger.models.Swagger swagger)

Creates a Swagger2MarkupConverter.Builder from a given Swagger model.

Parameters:

swagger - the Swagger source.

Returns:

a Swagger2MarkupConverter

from

public static Swagger2MarkupConverter.Builder from(java.lang.String swaggerString)

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

Parameters:

swaggerString - the Swagger YAML or JSON String.

Returns:

a Swagger2MarkupConverter

from

public static Swagger2MarkupConverter.Builder from(java.io.Reader swaggerReader)

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

Parameters:

swaggerReader - the Swagger YAML or JSON reader.

Returns:

a Swagger2MarkupConverter

getContext

public Swagger2MarkupConverter.Context getContext()

Returns the global Context

Returns:

the global Context

toFolder

public void toFolder(java.nio.file.Path outputDirectory)

Converts the Swagger specification into the given outputDirectory.

Parameters:

outputDirectory - the output directory path

toPath

public void toPath(java.nio.file.Path outputPath)

Converts the Swagger specification into the outputPath which can be either a directory (e.g /tmp) or a file without extension (e.g /tmp/swagger). Internally the method invokes either toFolder or toFile. If the outputPath is a directory, the directory must exist. Otherwise it cannot be determined if the outputPath is a directory or not.

Parameters:

outputPath - the output path

toFile

public void toFile(java.nio.file.Path outputFile)

Converts the Swagger specification the given outputFile.
An extension identifying the markup language will be automatically added to file name.

Parameters:

outputFile - the output file

toFileWithoutExtension

public void toFileWithoutExtension(java.nio.file.Path outputFile)

Converts the Swagger specification the given outputFile.

Parameters:

outputFile - the output file

toString

public java.lang.String toString()

Builds the document returns it as a String.

Overrides:

toString in class java.lang.Object

Returns:

the document as a String