文档与操作

用这些类型编写 OpenAPI 文档，或描述生成器的输入。它们描述数据，不负责获取文档、执行 OpenAPI 规范校验或调用操作。

文档契约

类型	必填字段与行为
`OpenAPI`	必填 `openapi: string`、`info: Info`、`paths: Paths`；可选 servers、components、security、tags、externalDocs
`Info`	本包所有字段均可选，包括 title/version；约束弱于规范校验器
`Contact`、`License`	Contact 字段均可选；License 必填 name
`Server`、`ServerVariable`	Server 必填 url；变量必填 default；这里不执行 URL 插值
`Tag`、`ExternalDocumentation`	分别必填 name、url；仅描述元数据
`Paths`、`PathItem`、`HTTPMethod`	Paths 将字符串映射到路径项；支持八种小写方法键、共享参数/servers、可选 `$ref`
`Operation`	必填 responses；可选 operationId、tags、parameters、body、callbacks、security、servers

参数与响应

Parameter 必填 name 和 in（query、header、path、cookie）。序列化提示（style、explode、allowReserved、allowEmptyValue）均可选，本包不提供运行时默认值。不强制路径参数设置 required: true，也不强制 schema/content 或 example/examples 互斥。

RequestBody 必填媒体类型到 MediaType 的 content 映射。MediaType 可含 Schema/Reference、示例和按属性配置的 Encoding。Header 类似 Parameter，但没有 name/in。Responses 将状态字符串映射到 Response | Reference | undefined，可配置 default。这些声明中的 Response.description 可选。Link 以 ID/ref 描述另一操作；Callback 将运行时表达式字符串映射到 PathItem。它们不跟随链接、发送回调、协商媒体类型或校验响应状态。

完整文档

下面仅为编译期示例，没有网络或需释放的资源。类型检查可发现已声明字段的拼写和值类型错误；外部 JSON 仍需应用层验证。

import type { OpenAPI } from '@ahoo-wang/fetcher-openapi';

const document: OpenAPI = {
  openapi: '3.0.3',
  info: { title: 'Items', version: '1.0.0' },
  tags: [{ name: 'Items' }],
  paths: {
    '/items/{id}': {
      get: {
        operationId: 'getItem',
        tags: ['Items'],
        parameters: [
          {
            name: 'id',
            in: 'path',
            required: true,
            schema: { type: 'string' },
          },
        ],
        responses: {
          '200': {
            description: 'Found',
            content: {
              'application/json': {
                schema: {
                  type: 'object',
                  required: ['id'],
                  properties: { id: { type: 'string' } },
                },
              },
            },
          },
        },
      },
    },
  },
};
console.log(document.paths['/items/{id}'].get?.operationId);

OpenAPI

packages/openapi/src/openAPI.ts:41

export interface OpenAPI extends Extensible {
  openapi: string;
  info: Info;
  servers?: Server[];
  paths: Paths;
  components?: Components;
  security?: SecurityRequirement[];
  tags?: Tag[];
  externalDocs?: ExternalDocumentation;
}

Contact

packages/openapi/src/info.ts:27

export interface Contact extends Extensible {
  name?: string;
  url?: string;
  email?: string;
}

License

packages/openapi/src/info.ts:39

export interface License extends Extensible {
  name: string;
  url?: string;
}

Info

packages/openapi/src/info.ts:54

export interface Info extends Extensible {
  title?: string;
  description?: string;
  termsOfService?: string;
  contact?: Contact;
  license?: License;
  version?: string;
}

ServerVariable

packages/openapi/src/server.ts:27

export interface ServerVariable extends Extensible {
  enum?: string[];
  default: string;
  description?: string;
}

Server

packages/openapi/src/server.ts:40

export interface Server extends Extensible {
  url: string;
  description?: string;
  variables?: Record<string, ServerVariable>;
}

Operation

packages/openapi/src/paths.ts:44

export interface Operation extends Extensible {
  tags?: string[];
  summary?: string;
  description?: string;
  externalDocs?: ExternalDocumentation;
  operationId?: string;
  parameters?: (Parameter | Reference)[];
  requestBody?: RequestBody | Reference;
  responses: Responses;
  callbacks?: Record<string, Callback | Reference>;
  deprecated?: boolean;
  security?: SecurityRequirement[];
  servers?: Server[];
}

PathItem

packages/openapi/src/paths.ts:76

export interface PathItem extends Extensible {
  $ref?: string;
  summary?: string;
  description?: string;
  get?: Operation;
  put?: Operation;
  post?: Operation;
  delete?: Operation;
  options?: Operation;
  head?: Operation;
  patch?: Operation;
  trace?: Operation;
  servers?: Server[];
  parameters?: (Parameter | Reference)[];
}

Paths

packages/openapi/src/paths.ts:95

export interface Paths extends Extensible {
  [path: string]: PathItem;
}

Parameter

packages/openapi/src/parameters.ts:40

export interface Parameter extends Extensible {
  name: string;
  in: ParameterLocation;
  description?: string;
  required?: boolean;
  deprecated?: boolean;
  allowEmptyValue?: boolean;
  style?: string;
  explode?: boolean;
  allowReserved?: boolean;
  schema?: Schema | Reference;
  example?: any;
  examples?: Record<string, Example | Reference>;
  content?: Record<string, MediaType>;
}

RequestBody

packages/openapi/src/parameters.ts:63

export interface RequestBody extends Extensible {
  description?: string;
  content: Record<string, MediaType>;
  required?: boolean;
}

MediaType

packages/openapi/src/parameters.ts:77

export interface MediaType extends Extensible {
  schema?: Schema | Reference;
  example?: any;
  examples?: Record<string, Example | Reference>;
  encoding?: Record<string, Encoding>;
}

Encoding

packages/openapi/src/parameters.ts:93

export interface Encoding extends Extensible {
  contentType?: string;
  headers?: Record<string, Header | Reference>;
  style?: string;
  explode?: boolean;
  allowReserved?: boolean;
}

Link

packages/openapi/src/responses.ts:35

export interface Link extends Extensible {
  operationRef?: string;
  operationId?: string;
  parameters?: Record<string, any>;
  requestBody?: any;
  description?: string;
  server?: Server;
}

Response

packages/openapi/src/responses.ts:52

export interface Response extends Extensible {
  description?: string;
  headers?: Record<string, Header | Reference>;
  content?: Record<string, MediaType>;
  links?: Record<string, Link | Reference>;
}

Responses

packages/openapi/src/responses.ts:62

export interface Responses extends Extensible {
  default?: Response | Reference;

  [httpCode: string]: Response | Reference | undefined;
}

Callback

packages/openapi/src/responses.ts:71

export interface Callback extends Extensible {
  [expression: string]: PathItem;
}

Tag

packages/openapi/src/tags.ts:24

export interface Tag extends Extensible {
  name: string;
  description?: string;
  externalDocs?: ExternalDocumentation;
}

HTTPMethod

packages/openapi/src/base-types.ts:26

export type HTTPMethod =
  'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';

ParameterLocation

packages/openapi/src/base-types.ts:39

export type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';

ExternalDocumentation

packages/openapi/src/base-types.ts:59

export interface ExternalDocumentation extends Extensible {
  description?: string;
  url: string;
}

Example

packages/openapi/src/base-types.ts:72

export interface Example extends Extensible {
  summary?: string;
  description?: string;
  value?: any;
  externalValue?: string;
}

packages/openapi/src/base-types.ts:82

export interface Header extends Extensible {
  description?: string;
  required?: boolean;
  deprecated?: boolean;
  allowEmptyValue?: boolean;
  style?: string;
  explode?: boolean;
  allowReserved?: boolean;
  schema?: Schema | Reference;
  example?: any;
  examples?: Record<string, Example | Reference>;
  content?: Record<string, MediaType>;
}

文档与操作 ​

文档契约 ​

参数与响应 ​

完整文档 ​

OpenAPI ​

Contact ​

License ​

Info ​

ServerVariable ​

Server ​

Operation ​

PathItem ​

Paths ​

Parameter ​

RequestBody ​

MediaType ​

Encoding ​

Link ​

Response ​

Responses ​

Callback ​

Tag ​

HTTPMethod ​

ParameterLocation ​

ExternalDocumentation ​

Example ​

Header ​