io.github.robwin.swagger2markup

Class Swagger2MarkupConverter

java.lang.Object

io.github.robwin.swagger2markup.Swagger2MarkupConverter

public class Swagger2MarkupConverter
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Swagger2MarkupConverter.Builder

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	asString() Builds the document with the given markup language and returns it as a String
static Swagger2MarkupConverter.Builder	from(java.lang.String swaggerLocation) Creates a Swagger2MarkupConverter.Builder using a given Swagger source.
static Swagger2MarkupConverter.Builder	from(io.swagger.models.Swagger swagger) Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
static Swagger2MarkupConverter.Builder	fromString(java.lang.String swaggerAsString) Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
void	intoFolder(java.lang.String targetFolderPath) Builds the document with the given markup language and stores the files in the given folder.

Methods inherited from class java.lang.Object

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

Method Detail

from

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

Creates a Swagger2MarkupConverter.Builder using a given Swagger source.

Parameters:

swaggerLocation - the Swagger location. Can be a HTTP url or a path to a local file.

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

fromString

public static Swagger2MarkupConverter.Builder fromString(java.lang.String swaggerAsString)
                                                  throws java.io.IOException

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

Parameters:

swaggerAsString - the Swagger YAML or JSON String.

Returns:

a Swagger2MarkupConverter

Throws:

java.io.IOException - if String can not be parsed

intoFolder

public void intoFolder(java.lang.String targetFolderPath)
                throws java.io.IOException

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

Parameters:

targetFolderPath - the target folder

Throws:

java.io.IOException - if the files cannot be written

asString

public java.lang.String asString()
                          throws java.io.IOException

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

Returns:

a the document as a String

Throws:

java.io.IOException - if files can not be read