erest
Preparing search index...
APIDefine
Interface APIDefine<T>
interface
APIDefine
<
T
>
{
before
?:
T
[]
;
body
?:
Record
<
string
,
ISchemaType
>
;
description
?:
string
;
group
?:
string
;
handler
?:
T
;
headers
?:
Record
<
string
,
ISchemaType
>
;
method
:
"get"
|
"post"
|
"put"
|
"delete"
|
"patch"
;
middlewares
?:
T
[]
;
mock
?:
Record
<
string
,
unknown
>
;
params
?:
Record
<
string
,
ISchemaType
>
;
path
:
string
;
query
?:
Record
<
string
,
ISchemaType
>
;
required
?:
string
[]
;
requiredOneOf
?:
string
[]
;
response
?:
TYPE_RESPONSE
;
title
:
string
;
}
Type Parameters
T
Hierarchy (
View Summary
)
APICommon
<
T
>
APIDefine
Index
Properties
before?
body?
description?
group?
handler?
headers?
method
middlewares?
mock?
params?
path
query?
required?
required
One
Of?
response?
title
Properties
Optional
before
before
?:
T
[]
Optional
body
body
?:
Record
<
string
,
ISchemaType
>
Optional
description
description
?:
string
Optional
group
group
?:
string
Optional
handler
handler
?:
T
Optional
headers
headers
?:
Record
<
string
,
ISchemaType
>
method
method
:
"get"
|
"post"
|
"put"
|
"delete"
|
"patch"
Optional
middlewares
middlewares
?:
T
[]
Optional
mock
mock
?:
Record
<
string
,
unknown
>
Optional
params
params
?:
Record
<
string
,
ISchemaType
>
path
path
:
string
Optional
query
query
?:
Record
<
string
,
ISchemaType
>
Optional
required
required
?:
string
[]
Optional
required
One
Of
requiredOneOf
?:
string
[]
Optional
response
response
?:
TYPE_RESPONSE
title
title
:
string
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
before
body
description
group
handler
headers
method
middlewares
mock
params
path
query
required
required
One
Of
response
title
erest
Loading...