org.lastaflute.doc

クラス SwaggerGenerator

java.lang.Object

org.lastaflute.doc.SwaggerGenerator

public class SwaggerGenerator
extends Object

作成者:

p1us2er0, jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static Pattern	HTTP_METHOD_PATTERN

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	adaptHeaderParameters(Map<String,Object> swaggerMap, List<Map<String,Object>> headerParameterList)
protected void	adaptSecurityDefinitions(Map<String,Object> swaggerMap, List<Map<String,Object>> securityDefinitionList)
protected List<Map<String,String>>	buildEnumMapList(Class<? extends Enum<?>> typeClass)
protected ActionDocumentGenerator	createActionDocumentGenerator()
protected DocumentGenerator	createDocumentGenerator()
protected org.lastaflute.core.json.engine.GsonJsonEngine	createJsonParser()
protected Map<String,String>	createSwaggerInfoMap()
protected Map<String,Object>	createSwaggerMap(SwaggerOption swaggerOption)
protected SwaggerOption	createSwaggerOption(Consumer<SwaggerOption> opLambda)
protected Map<Class<?>,org.lastaflute.di.util.tiger.Tuple3<String,String,Function<Object,Object>>>	createTypeMap()
protected String	derivedBasePath(SwaggerOption swaggerOption)
protected String	derivedDefinitionName(TypeDocMeta typeDocMeta)
protected org.dbflute.optional.OptionalThing<Object>	deriveDefaultValue(TypeDocMeta typeDocMeta)
protected Object	deriveDefaultValueByComment(String comment)
protected org.dbflute.optional.OptionalThing<List<String>>	derivedProduces(ActionDocMeta actiondocMeta)
protected List<String>	derivedRequiredPropertyNameList(TypeDocMeta typeDocMeta)
protected void	doSetupSwaggerPathMap(Map<String,Map<String,Object>> swaggerPathMap, Map<String,Map<String,Object>> swaggerDefinitionsMap, List<Map<String,Object>> swaggerTagList, ActionDocMeta actiondocMeta)
protected String	extractHttpMethod(ActionDocMeta actiondocMeta)
Map<String,Object>	generateSwaggerMap() Generate swagger map.
Map<String,Object>	generateSwaggerMap(Consumer<SwaggerOption> opLambda) Generate swagger map with option.
protected org.lastaflute.core.direction.AccessibleConfig	getAccessibleConfig()
protected LocalDate	getDefaultLocalDate()
protected LocalDateTime	getDefaultLocalDateTime()
protected LocalTime	getDefaultLocalTime()
protected org.lastaflute.core.json.JsonManager	getJsonManager()
protected String	getLastaDocDir()
protected DateTimeFormatter	getLocalDateFormatter()
protected DateTimeFormatter	getLocalDateTimeFormatter()
protected DateTimeFormatter	getLocalTimeFormatter()
protected List<Class<? extends Annotation>>	getRequiredAnnotationList()
protected org.dbflute.optional.OptionalThing<String>	prepareApplicationVersion()
protected String	prepareSwaggerMapRefDefinitions(ActionDocMeta actiondocMeta)
protected void	prepareSwaggerMapResponseMap(Map<String,Object> swaggerHttpMethodMap, ActionDocMeta actiondocMeta, Map<String,Map<String,Object>> swaggerDefinitionsMap)
protected List<String>	prepareSwaggerMapSchemes()
protected List<String>	prepareSwaggerMapTags(ActionDocMeta actiondocMeta)
protected String	putDefinition(Map<String,Map<String,Object>> definitionsMap, TypeDocMeta typeDocMeta)
protected org.dbflute.optional.OptionalThing<Map<String,Object>>	readSwaggerJson()
void	saveSwaggerMeta(LaActionSwaggerable swaggerable)
protected void	setupBeanList(TypeDocMeta typeDocMeta, Map<String,Map<String,Object>> definitionsMap, Map<Class<?>,org.lastaflute.di.util.tiger.Tuple3<String,String,Function<Object,Object>>> typeMap, Map<String,Object> schemaMap)
protected void	setupSwaggerPathMap(Map<String,Map<String,Object>> swaggerPathMap, Map<String,Map<String,Object>> swaggerDefinitionsMap, List<Map<String,Object>> swaggerTagList)
protected Map<String,Object>	toParameterMap(TypeDocMeta typeDocMeta, Map<String,Map<String,Object>> definitionsMap)

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

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

フィールドの詳細

HTTP_METHOD_PATTERN

protected static final Pattern HTTP_METHOD_PATTERN

コンストラクタの詳細

SwaggerGenerator

public SwaggerGenerator()

メソッドの詳細

generateSwaggerMap

public Map<String,Object> generateSwaggerMap()

Generate swagger map. (no option)

戻り値:

The map of swagger information. (NotNull)

generateSwaggerMap

public Map<String,Object> generateSwaggerMap(Consumer<SwaggerOption> opLambda)

Generate swagger map with option.

 new SwaggerGenerator().generateSwaggerMap(op -> {
     op.deriveBasePath(basePath -> basePath + "api/");
 });
 

パラメータ:

opLambda - The callback for settings of option. (NotNull)

戻り値:

The map of swagger information. (NotNull)

createSwaggerOption

protected SwaggerOption createSwaggerOption(Consumer<SwaggerOption> opLambda)

saveSwaggerMeta

public void saveSwaggerMeta(LaActionSwaggerable swaggerable)

readSwaggerJson

protected org.dbflute.optional.OptionalThing<Map<String,Object>> readSwaggerJson()

createSwaggerMap

protected Map<String,Object> createSwaggerMap(SwaggerOption swaggerOption)

createSwaggerInfoMap

protected Map<String,String> createSwaggerInfoMap()

prepareSwaggerMapSchemes

protected List<String> prepareSwaggerMapSchemes()

derivedBasePath

protected String derivedBasePath(SwaggerOption swaggerOption)

setupSwaggerPathMap

protected void setupSwaggerPathMap(Map<String,Map<String,Object>> swaggerPathMap,
                                   Map<String,Map<String,Object>> swaggerDefinitionsMap,
                                   List<Map<String,Object>> swaggerTagList)

doSetupSwaggerPathMap

protected void doSetupSwaggerPathMap(Map<String,Map<String,Object>> swaggerPathMap,
                                     Map<String,Map<String,Object>> swaggerDefinitionsMap,
                                     List<Map<String,Object>> swaggerTagList,
                                     ActionDocMeta actiondocMeta)

extractHttpMethod

protected String extractHttpMethod(ActionDocMeta actiondocMeta)

prepareSwaggerMapRefDefinitions

protected String prepareSwaggerMapRefDefinitions(ActionDocMeta actiondocMeta)

prepareSwaggerMapTags

protected List<String> prepareSwaggerMapTags(ActionDocMeta actiondocMeta)

prepareSwaggerMapResponseMap

protected void prepareSwaggerMapResponseMap(Map<String,Object> swaggerHttpMethodMap,
                                            ActionDocMeta actiondocMeta,
                                            Map<String,Map<String,Object>> swaggerDefinitionsMap)

adaptSecurityDefinitions

protected void adaptSecurityDefinitions(Map<String,Object> swaggerMap,
                                        List<Map<String,Object>> securityDefinitionList)

adaptHeaderParameters

protected void adaptHeaderParameters(Map<String,Object> swaggerMap,
                                     List<Map<String,Object>> headerParameterList)

toParameterMap

protected Map<String,Object> toParameterMap(TypeDocMeta typeDocMeta,
                                            Map<String,Map<String,Object>> definitionsMap)

setupBeanList

protected void setupBeanList(TypeDocMeta typeDocMeta,
                             Map<String,Map<String,Object>> definitionsMap,
                             Map<Class<?>,org.lastaflute.di.util.tiger.Tuple3<String,String,Function<Object,Object>>> typeMap,
                             Map<String,Object> schemaMap)

putDefinition

protected String putDefinition(Map<String,Map<String,Object>> definitionsMap,
                               TypeDocMeta typeDocMeta)

derivedRequiredPropertyNameList

protected List<String> derivedRequiredPropertyNameList(TypeDocMeta typeDocMeta)

derivedDefinitionName

protected String derivedDefinitionName(TypeDocMeta typeDocMeta)

derivedProduces

protected org.dbflute.optional.OptionalThing<List<String>> derivedProduces(ActionDocMeta actiondocMeta)

createTypeMap

protected Map<Class<?>,org.lastaflute.di.util.tiger.Tuple3<String,String,Function<Object,Object>>> createTypeMap()

getRequiredAnnotationList

protected List<Class<? extends Annotation>> getRequiredAnnotationList()

buildEnumMapList

protected List<Map<String,String>> buildEnumMapList(Class<? extends Enum<?>> typeClass)

createDocumentGenerator

protected DocumentGenerator createDocumentGenerator()

createActionDocumentGenerator

protected ActionDocumentGenerator createActionDocumentGenerator()

prepareApplicationVersion

protected org.dbflute.optional.OptionalThing<String> prepareApplicationVersion()

getDefaultLocalDate

protected LocalDate getDefaultLocalDate()

getDefaultLocalDateTime

protected LocalDateTime getDefaultLocalDateTime()

getDefaultLocalTime

protected LocalTime getDefaultLocalTime()

getLocalDateFormatter

protected DateTimeFormatter getLocalDateFormatter()

getLocalDateTimeFormatter

protected DateTimeFormatter getLocalDateTimeFormatter()

getLocalTimeFormatter

protected DateTimeFormatter getLocalTimeFormatter()

deriveDefaultValue

protected org.dbflute.optional.OptionalThing<Object> deriveDefaultValue(TypeDocMeta typeDocMeta)

deriveDefaultValueByComment

protected Object deriveDefaultValueByComment(String comment)

createJsonParser

protected org.lastaflute.core.json.engine.GsonJsonEngine createJsonParser()

getLastaDocDir

protected String getLastaDocDir()

getAccessibleConfig

protected org.lastaflute.core.direction.AccessibleConfig getAccessibleConfig()

getJsonManager

protected org.lastaflute.core.json.JsonManager getJsonManager()