@grandlinex/swagger-mate
Preparing search index...
SwaggerUtil
Class SwaggerUtil
Index
Constructors
constructor
Methods
merge
merge
Config
meta
Extractor
read
Meta
route
To
Swagger
Path
serve
Meta
write
Meta
Constructors
constructor
new
SwaggerUtil
()
:
SwaggerUtil
Returns
SwaggerUtil
Methods
Static
merge
merge
(
root
:
SwaggerConfig
,
data
:
MergeInputType
[]
)
:
SwaggerConfig
Parameters
root
:
SwaggerConfig
data
:
MergeInputType
[]
Returns
SwaggerConfig
Static
merge
Config
mergeConfig
(
root
:
SwaggerConfig
,
data
:
SwaggerConfig
[]
)
:
SwaggerConfig
Parameters
root
:
SwaggerConfig
data
:
SwaggerConfig
[]
Returns
SwaggerConfig
Static
meta
Extractor
metaExtractor
(
root
:
Object
,
npmPackageVersion
:
boolean
,
...
path
:
Object
[]
,
)
:
undefined
|
SwaggerConfig
Parameters
root
:
Object
npmPackageVersion
:
boolean
...
path
:
Object
[]
Returns
undefined
|
SwaggerConfig
Static
read
Meta
readMeta
(
path
:
string
)
:
any
Parameters
path
:
string
Returns
any
Static
route
To
Swagger
Path
routeToSwaggerPath
(
route
:
RouteData
)
:
SwaggerRPath
Parameters
route
:
RouteData
Returns
SwaggerRPath
Static
serve
Meta
serveMeta
(
conf
:
SwaggerConfig
,
port
?:
number
,
auth
?:
string
,
)
:
Promise
<
null
|
Server
>
Parameters
conf
:
SwaggerConfig
Optional
port
:
number
Optional
auth
:
string
Returns
Promise
<
null
|
Server
>
Static
write
Meta
writeMeta
(
conf
:
SwaggerConfig
,
kind
:
"JSON"
|
"YAML"
,
path
?:
string
)
:
void
Parameters
conf
:
SwaggerConfig
kind
:
"JSON"
|
"YAML"
Optional
path
:
string
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
merge
merge
Config
meta
Extractor
read
Meta
route
To
Swagger
Path
serve
Meta
write
Meta
@grandlinex/swagger-mate
Loading...