io.github.swagger2markup.extensions

Class SpringRestDocsExtension

java.lang.Object

io.github.swagger2markup.spi.PathsDocumentExtension

io.github.swagger2markup.extensions.SpringRestDocsExtension

public final class SpringRestDocsExtension
extends io.github.swagger2markup.spi.PathsDocumentExtension

Append Spring Rest docs generated snippets to Operations content.

Nested Class Summary

Nested classes/interfaces inherited from class io.github.swagger2markup.spi.PathsDocumentExtension

io.github.swagger2markup.spi.PathsDocumentExtension.Context, io.github.swagger2markup.spi.PathsDocumentExtension.Position

Field Summary

Fields

Modifier and Type	Field and Description
protected io.github.swagger2markup.Swagger2MarkupConverter.Context	globalContext
protected java.net.URI	snippetBaseUri
protected java.util.Map<java.lang.String,java.lang.String>	snippets

Constructor Summary

Constructors

Constructor and Description
SpringRestDocsExtension()
SpringRestDocsExtension(java.lang.String extensionId, java.net.URI snippetBaseUri, io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage) Instantiate extension
SpringRestDocsExtension(java.net.URI snippetBaseUri, io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage) Instantiate extension with the default extension id.

Method Summary

Modifier and Type	Method and Description
void	apply(io.github.swagger2markup.spi.PathsDocumentExtension.Context context)
void	init(io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext)
java.net.URI	operationSnippetUri(io.github.swagger2markup.spi.PathsDocumentExtension.Context context, io.github.swagger2markup.model.PathOperation operation, java.lang.String snippetName) Builds snippet URI for the given operation and snippetName.
void	snippets(io.github.swagger2markup.spi.PathsDocumentExtension.Context context)
void	snippetSection(io.github.swagger2markup.spi.PathsDocumentExtension.Context context, java.lang.String snippetName, java.lang.String title)
SpringRestDocsExtension	withDefaultSnippets() Add SpringRestDocs default snippets to list
SpringRestDocsExtension	withExplicitSnippets(java.util.Map<java.lang.String,java.lang.String> snippets) Add an explicit list of snippets to display.

Methods inherited from class io.github.swagger2markup.spi.PathsDocumentExtension

levelOffset

Methods inherited from class java.lang.Object

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

Field Detail

snippetBaseUri

protected java.net.URI snippetBaseUri

snippets

protected java.util.Map<java.lang.String,java.lang.String> snippets

globalContext

protected io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext

Constructor Detail

SpringRestDocsExtension

public SpringRestDocsExtension(java.net.URI snippetBaseUri,
                               io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage)

Instantiate extension with the default extension id.

Parameters:

snippetBaseUri - base URI where the snippets are stored

extensionMarkupLanguage - the MarkupLanguage of the snippets content

SpringRestDocsExtension

public SpringRestDocsExtension(java.lang.String extensionId,
                               java.net.URI snippetBaseUri,
                               io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage)

Instantiate extension

Parameters:

extensionId - the unique ID of the extension

snippetBaseUri - base URI where the snippets are stored

extensionMarkupLanguage - the MarkupLanguage of the snippets content

SpringRestDocsExtension

public SpringRestDocsExtension()

Method Detail

init

public void init(io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext)

Overrides:

init in class io.github.swagger2markup.spi.PathsDocumentExtension

withDefaultSnippets

public SpringRestDocsExtension withDefaultSnippets()

Add SpringRestDocs default snippets to list

Returns:

this instance

withExplicitSnippets

public SpringRestDocsExtension withExplicitSnippets(java.util.Map<java.lang.String,java.lang.String> snippets)

Add an explicit list of snippets to display.

Parameters:

snippets - snippets to add. key is snippet name (without extension, e.g.: 'http-request'), value is a custom section title for the snippet.

Returns:

this instance

operationSnippetUri

public java.net.URI operationSnippetUri(io.github.swagger2markup.spi.PathsDocumentExtension.Context context,
                                        io.github.swagger2markup.model.PathOperation operation,
                                        java.lang.String snippetName)

Builds snippet URI for the given operation and snippetName.
Default implementation use <snippetBaseUri>/<normalizeName(<operation id>)>/<snippetName>.<markup ext>.
You can override this method to configure your own folder normalization.

Parameters:

context - current context

operation - current operation

Returns:

subdirectory normalized name

apply

public void apply(io.github.swagger2markup.spi.PathsDocumentExtension.Context context)

Specified by:

apply in class io.github.swagger2markup.spi.PathsDocumentExtension

snippets

public void snippets(io.github.swagger2markup.spi.PathsDocumentExtension.Context context)

snippetSection

public void snippetSection(io.github.swagger2markup.spi.PathsDocumentExtension.Context context,
                           java.lang.String snippetName,
                           java.lang.String title)