ApiDefine API

Field Definitions

Field	Type	Default	Description
path	String	-	HTTP path
view	String	"json"	Response type
invokeType	String	"automatic"	Invoke type
method	String	-	HTTP method
beforeScriptId	String	-	Script ID to call before API invocation
beforeScriptFunc	String	-	Script function to call before API invocation
automaticId	String	-	Automation ID to invoke
scriptId	String	-	Script ID to invoke
scriptFunc	String	-	Script function to invoke
afterScriptId	String	-	Script ID to call after API invocation
afterScriptFunc	String	-	Script function to call after API invocation
errorScriptId	String	-	Script ID to call on API invocation error
errorScriptFunc	String	-	Script function to call on API invocation error
apiDesc	String	-	Description
isEnable	boolean	true	Whether enabled
jsonConfigWriteMapNullValue	boolean	-	When response type is JSON, whether to output keys with NULL values
enableRateLimiter	boolean	-	Enable rate limiting
rateLimiterQps	double	-	Queries per second
rateLimiterTimeout	int	-	Timeout duration
rateLimiterKeyVar	String	-	Rate limiter key expression

Inherited Fields (from DefineObject)

Field	Type	Default	Description
id	String	-	Unique identifier
key	String	-	Key
scope	String	-	Scope
name	String	-	Name (required)
displayName	String	-	Display name
remark	String	-	Remark
build	Long	0L	Build version number, uses incrementing numbers. If version numbers differ, this configuration item needs to be processed (incremented by 1 when app is published)
draftVersion	Long	0L	Draft version number
ignoreAddVersion	Boolean	false	Ignore add version number
isDeleted	Boolean	false	Mark whether the definition is deleted
parentId	String	-	Parent node ID
parentName	String	-	Parent node name
createUser	String	-	Created by user
updateUser	String	-	Updated by user
createTime	String	-	Create time
updateTime	String	-	Update time