Share via


IApiDefinition interface

Properties

method

HTTP method (GET, POST, etc.)

parameters

Parameters

path

API path

responseInfo

Response information

Property Details

method

HTTP method (GET, POST, etc.)

method: string

Property Value

string

parameters

Parameters

parameters: { in: string, name: string, required: boolean, type: string }[]

Property Value

{ in: string, name: string, required: boolean, type: string }[]

path

API path

path: string

Property Value

string

responseInfo

Response information

responseInfo?: Record<string, IApiResponseInfo>

Property Value

Record<string, IApiResponseInfo>