程序包 springfox.documentation.spi.service

接口 DocumentationPlugin

所有超级接口:

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

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

方法概要

修饰符和类型	方法	说明
DocumentationContext	configure(DocumentationContextBuilder builder)	Creates a documentation context based on a given DocumentationContextBuilder
DocumentationType	getDocumentationType()
String	getGroupName()	Gets the group name for the plugin.
boolean	isEnabled()

从接口继承的方法 org.springframework.plugin.core.Plugin

supports

方法详细资料

isEnabled

boolean isEnabled()

返回:

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

参数:

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

返回:

context to use for building the documentation

getGroupName

String getGroupName()

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

返回:

group the plugin belongs to