api-morph / OperationData

Interface: OperationData

Defined in: src/types/parser.ts:103

TagParser 解析后的结果

Properties

callback?

optional callback: object

Defined in: src/types/parser.ts:125

回调定义

callback

callback: CallbackObject

name

name: string

---

deprecated?

optional deprecated: boolean

Defined in: src/types/parser.ts:127

操作已废弃标志

---

description?

optional description: string

Defined in: src/types/parser.ts:113

描述

---

extensions?

optional extensions: Record<`x-${string}`, any>

Defined in: src/types/parser.ts:133

扩展属性

---

externalDocs?

optional externalDocs: ExternalDocumentationObject

Defined in: src/types/parser.ts:115

外部文档

---

method?

optional method: HttpMethod

Defined in: src/types/parser.ts:105

HTTP 方法

---

operationId?

optional operationId: string

Defined in: src/types/parser.ts:117

操作ID

---

parameters?

optional parameters: ParameterObject[]

Defined in: src/types/parser.ts:119

参数定义

---

path?

optional path: string

Defined in: src/types/parser.ts:107

API 路径

---

requestBody?

optional requestBody: RequestBodyObject

Defined in: src/types/parser.ts:121

请求体定义

---

responses?

optional responses: Record<string, ResponseObject>

Defined in: src/types/parser.ts:123

响应定义

---

responsesExtensions?

optional responsesExtensions: Record<`x-${string}`, any>

Defined in: src/types/parser.ts:135

响应扩展属性

---

security?

optional security: SecurityRequirementObject

Defined in: src/types/parser.ts:129

安全要求

---

servers?

optional servers: ServerObject[]

Defined in: src/types/parser.ts:131

服务器定义

---

summary?

optional summary: string

Defined in: src/types/parser.ts:111

摘要

---

tags?

optional tags: string[]

Defined in: src/types/parser.ts:109

标签