springfox.documentation.spi.service

Interface DocumentationPlugin

All Superinterfaces:

org.springframework.plugin.core.Plugin<DocumentationType>

All Known Implementing Classes:

Docket

public interface DocumentationPlugin
extends org.springframework.plugin.core.Plugin<DocumentationType>

Method Summary

Methods

Modifier and Type	Method and Description
DocumentationContext	configure(DocumentationContextBuilder builder) Creates a documentation context based on a given DocumentationContextBuilder
DocumentationType	getDocumentationType()
java.lang.String	getGroupName() Gets the group name for the plugin.
boolean	isEnabled()

Methods inherited from interface org.springframework.plugin.core.Plugin

supports

Method Detail

isEnabled

boolean isEnabled()

Returns:

indicator to determine if the plugin is enabled

getDocumentationType

DocumentationType getDocumentationType()

configure

DocumentationContext configure(DocumentationContextBuilder builder)

Creates a documentation context based on a given DocumentationContextBuilder

Parameters:

builder - - @see springfox.documentation.spi.service.contexts.DocumentationContextBuilder

Returns:

context to use for building the documentation

getGroupName

java.lang.String getGroupName()

Gets the group name for the plugin. This is expected to be unique for each instance of the plugin

Returns:

group the plugin belongs to