org.lastaflute.doc

クラス SwaggerOption

java.lang.Object

org.lastaflute.doc.SwaggerOption

public class SwaggerOption
extends Object

作成者:

p1us2er0, jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	SwaggerOption.SwaggerHeaderParameterResource
static class	SwaggerOption.SwaggerSecurityDefinitionResource

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Function<String,String>	basePathLambda
protected List<Map<String,Object>>	headerParameterList
protected List<Map<String,Object>>	securityDefinitionList

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SwaggerOption()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addHeaderParameter(String name, String value)
void	addHeaderParameter(String name, String value, Consumer<SwaggerOption.SwaggerHeaderParameterResource> resourceLambda)
void	addSecurityDefinition(String name)
void	addSecurityDefinition(String name, Consumer<SwaggerOption.SwaggerSecurityDefinitionResource> resourceLambda)
protected Map<String,Object>	createHeaderParameterMap(String name, String value)
protected Map<String,Object>	createSecurityDefinitionMap(String name)
void	derivedBasePath(Function<String,String> oneArgLambda) Derive application base path (e.g.
org.dbflute.optional.OptionalThing<Function<String,String>>	getDerivedBasePath()
org.dbflute.optional.OptionalThing<List<Map<String,Object>>>	getHeaderParameterList()
org.dbflute.optional.OptionalThing<List<Map<String,Object>>>	getSecurityDefinitionList()

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

basePathLambda

protected Function<String,String> basePathLambda

headerParameterList

protected List<Map<String,Object>> headerParameterList

securityDefinitionList

protected List<Map<String,Object>> securityDefinitionList

コンストラクタの詳細

SwaggerOption

public SwaggerOption()

メソッドの詳細

derivedBasePath

public void derivedBasePath(Function<String,String> oneArgLambda)

Derive application base path (e.g. /showbase/) by filter.

 op.derivedBasePath(basePath -> basePath + "api/");
 

パラメータ:

oneArgLambda - The callback of base path filter. (NotNull)

addHeaderParameter

public void addHeaderParameter(String name,
                               String value)

addHeaderParameter

public void addHeaderParameter(String name,
                               String value,
                               Consumer<SwaggerOption.SwaggerHeaderParameterResource> resourceLambda)

createHeaderParameterMap

protected Map<String,Object> createHeaderParameterMap(String name,
                                                      String value)

addSecurityDefinition

public void addSecurityDefinition(String name)

addSecurityDefinition

public void addSecurityDefinition(String name,
                                  Consumer<SwaggerOption.SwaggerSecurityDefinitionResource> resourceLambda)

createSecurityDefinitionMap

protected Map<String,Object> createSecurityDefinitionMap(String name)

getDerivedBasePath

public org.dbflute.optional.OptionalThing<Function<String,String>> getDerivedBasePath()

getHeaderParameterList

public org.dbflute.optional.OptionalThing<List<Map<String,Object>>> getHeaderParameterList()

getSecurityDefinitionList

public org.dbflute.optional.OptionalThing<List<Map<String,Object>>> getSecurityDefinitionList()