RestSchemaUtil (Moqui Framework 3.0.0)

org.moqui.impl.util.RestSchemaUtil

@groovy.transform.CompileStatic
class RestSchemaUtil
extends java.lang.Object

Field Summary

Fields
Modifiers	Name	Description
`protected static org.slf4j.Logger`	`logger`

Properties Summary

Properties
Type	Name and description
`static java.util.Map<java.lang.String, java.lang.String>`	`fieldTypeJsonFormatMap`
`static java.util.Map<java.lang.String, java.lang.String>`	`fieldTypeJsonMap`
`static java.util.Map<java.lang.String, java.lang.String>`	`fieldTypeRamlMap`
`static java.util.Map`	`jsonCountParameters`
`static java.util.Map`	`jsonPaginationParameters`
`static java.util.Map`	`jsonPaginationProperties`
`static java.util.Map`	`ramlPaginationParameters`
`static java.util.List<java.util.Map>`	`swaggerPaginationParameters`

Constructor Summary

Constructors
Constructor and description
`RestSchemaUtil ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`addParameterEnums(ServiceDefinition sd, MNode parmNode, java.util.Map<java.lang.String, java.lang.Object> propMap)`
	`static void`	`addToSwaggerMap(EntityDefinition ed, java.util.Map<java.lang.String, java.lang.Object> swaggerMap, java.lang.String masterName)`
	`static java.util.List<java.lang.String>`	`getFieldEnums(EntityDefinition ed, FieldInfo fi)`
	`static java.util.Map`	`getJsonSchema(EntityDefinition ed, boolean pkOnly, boolean standalone, java.util.Map<java.lang.String, java.lang.Object> definitionsMap, java.lang.String schemaUri, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean nestRelationships, java.lang.String masterName, MasterDetail masterDetail)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getJsonSchemaMapIn(ServiceDefinition sd)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getJsonSchemaMapOut(ServiceDefinition sd)`
	`protected static java.util.Map<java.lang.String, java.lang.Object>`	`getJsonSchemaPropMap(ServiceDefinition sd, MNode parmNode)`
	`static java.util.Map`	`getRamlApi(EntityDefinition ed, java.lang.String masterName)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getRamlFieldMap(EntityDefinition ed, FieldInfo fi)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getRamlMapIn(ServiceDefinition sd)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getRamlMapOut(ServiceDefinition sd)`
	`protected static java.util.Map<java.lang.String, java.lang.Object>`	`getRamlPropMap(MNode parmNode)`
	`static java.util.Map<java.lang.String, java.lang.Object>`	`getRamlTypeMap(EntityDefinition ed, boolean pkOnly, java.util.Map<java.lang.String, java.lang.Object> typesMap, java.lang.String masterName, MasterDetail masterDetail)`
	`static void`	`handleEntityRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)`
	`static void`	`handleEntityRestSchema(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String schemaUri, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)`
	`static void`	`handleEntityRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath, boolean getMaster)`
	`static void`	`handleServiceRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix)`
	`static void`	`handleServiceRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final org.slf4j.Logger logger
- Property Detail
  - static final java.util.Map<java.lang.String, java.lang.String> fieldTypeJsonFormatMap
  - static final java.util.Map<java.lang.String, java.lang.String> fieldTypeJsonMap
  - static final java.util.Map<java.lang.String, java.lang.String> fieldTypeRamlMap
  - static final java.util.Map jsonCountParameters
  - static final java.util.Map jsonPaginationParameters
  - static final java.util.Map jsonPaginationProperties
  - static final java.util.Map ramlPaginationParameters
  - static final java.util.List<java.util.Map> swaggerPaginationParameters
- Constructor Detail
  - RestSchemaUtil()
- Method Detail
  - static void addParameterEnums(ServiceDefinition sd, MNode parmNode, java.util.Map<java.lang.String, java.lang.Object> propMap)
  - static void addToSwaggerMap(EntityDefinition ed, java.util.Map<java.lang.String, java.lang.Object> swaggerMap, java.lang.String masterName)
  - static java.util.List<java.lang.String> getFieldEnums(EntityDefinition ed, FieldInfo fi)
  - static java.util.Map getJsonSchema(EntityDefinition ed, boolean pkOnly, boolean standalone, java.util.Map<java.lang.String, java.lang.Object> definitionsMap, java.lang.String schemaUri, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean nestRelationships, java.lang.String masterName, MasterDetail masterDetail)
  - static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaMapIn(ServiceDefinition sd)
  - static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaMapOut(ServiceDefinition sd)
  - protected static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaPropMap(ServiceDefinition sd, MNode parmNode)
  - static java.util.Map getRamlApi(EntityDefinition ed, java.lang.String masterName)
  - static java.util.Map<java.lang.String, java.lang.Object> getRamlFieldMap(EntityDefinition ed, FieldInfo fi)
  - static java.util.Map<java.lang.String, java.lang.Object> getRamlMapIn(ServiceDefinition sd)
  - static java.util.Map<java.lang.String, java.lang.Object> getRamlMapOut(ServiceDefinition sd)
  - protected static java.util.Map<java.lang.String, java.lang.Object> getRamlPropMap(MNode parmNode)
  - static java.util.Map<java.lang.String, java.lang.Object> getRamlTypeMap(EntityDefinition ed, boolean pkOnly, java.util.Map<java.lang.String, java.lang.Object> typesMap, java.lang.String masterName, MasterDetail masterDetail)
  - static void handleEntityRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)
  - static void handleEntityRestSchema(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String schemaUri, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)
  - static void handleEntityRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath, boolean getMaster)
  - static void handleServiceRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix)
  - static void handleServiceRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class RestSchemaUtil

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final org.slf4j.Logger logger

Property Detail

static final java.util.Map<java.lang.String, java.lang.String> fieldTypeJsonFormatMap

static final java.util.Map<java.lang.String, java.lang.String> fieldTypeJsonMap

static final java.util.Map<java.lang.String, java.lang.String> fieldTypeRamlMap

static final java.util.Map jsonCountParameters

static final java.util.Map jsonPaginationParameters

static final java.util.Map jsonPaginationProperties

static final java.util.Map ramlPaginationParameters

static final java.util.List<java.util.Map> swaggerPaginationParameters

Constructor Detail

RestSchemaUtil()

Method Detail

static void addParameterEnums(ServiceDefinition sd, MNode parmNode, java.util.Map<java.lang.String, java.lang.Object> propMap)

static void addToSwaggerMap(EntityDefinition ed, java.util.Map<java.lang.String, java.lang.Object> swaggerMap, java.lang.String masterName)

static java.util.List<java.lang.String> getFieldEnums(EntityDefinition ed, FieldInfo fi)

static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaMapIn(ServiceDefinition sd)

static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaMapOut(ServiceDefinition sd)

protected static java.util.Map<java.lang.String, java.lang.Object> getJsonSchemaPropMap(ServiceDefinition sd, MNode parmNode)

static java.util.Map getRamlApi(EntityDefinition ed, java.lang.String masterName)

static java.util.Map<java.lang.String, java.lang.Object> getRamlFieldMap(EntityDefinition ed, FieldInfo fi)

static java.util.Map<java.lang.String, java.lang.Object> getRamlMapIn(ServiceDefinition sd)

static java.util.Map<java.lang.String, java.lang.Object> getRamlMapOut(ServiceDefinition sd)

protected static java.util.Map<java.lang.String, java.lang.Object> getRamlPropMap(MNode parmNode)

static java.util.Map<java.lang.String, java.lang.Object> getRamlTypeMap(EntityDefinition ed, boolean pkOnly, java.util.Map<java.lang.String, java.lang.Object> typesMap, java.lang.String masterName, MasterDetail masterDetail)

static void handleEntityRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)

static void handleEntityRestSchema(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String schemaUri, java.lang.String linkPrefix, java.lang.String schemaLinkPrefix, boolean getMaster)

static void handleEntityRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath, boolean getMaster)

static void handleServiceRestRaml(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String linkPrefix)

static void handleServiceRestSwagger(ExecutionContextImpl eci, java.util.List<java.lang.String> extraPathNameList, java.lang.String basePath)