Development

OpenAPI 转 TypeScript 类型生成器

将 OpenAPI 或 Swagger 的 JSON/YAML 规范转换为 TypeScript 接口类型、请求参数类型和响应类型，并支持输出格式与命名风格配置

text· 文本结果打开工具

快速开始

用三种语言从你的代码中调用此工具。

cURL

curl -X POST 'https://api.elysiatools.com/zh/api/tools/openapi-to-typescript-generator' \
  -H 'Content-Type: application/json' \
  -d '{"specInput":"openapi: 3.0.0\ninfo:\n  title: User API\n  version: 1.0.0\npaths:\n  /users/{id}:\n    get:\n      operationId: getUser\n      parameters:\n        - in: path\n          name: id\n          required: true\n          schema:\n            type: string\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/User\"\ncomponents:\n  schemas:\n    User:\n      type: object\n      required: [id, name]\n      properties:\n        id:\n          type: string\n        name:\n          type: string","sourceFormat":"yaml","outputFormat":"flat","namingStyle":"pascal","declarationStyle":"interface","namespaceName":"Api","includeOperationTypes":true,"includeDescriptions":true}'

API 参考

以 JSON 形式 POST 提交输入参数。文件类型参数需先单独上传。

请求端点

HTTP

POST https://api.elysiatools.com/zh/api/tools/openapi-to-typescript-generator

请求参数

参数名	类型	必填	说明
specInput	textarea	是	—
sourceFormat	select	否	—
outputFormat	select	否	—
namingStyle	select	否	—
declarationStyle	select	否	—
namespaceName	text	否	—
includeOperationTypes	checkbox	否	—
includeDescriptions	checkbox	否	—

响应格式

文本结果

JSON

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}

MCP 集成

将此工具加入你的 Model Context Protocol 服务，让 AI 智能体可以列出并调用它。

服务配置

将以下内容加入你的 MCP 客户端配置：

mcp.json

{
  "mcpServers": {
    "elysiatools-openapi-to-typescript-generator": {
      "name": "openapi-to-typescript-generator",
      "description": "将 OpenAPI 或 Swagger 的 JSON/YAML 规范转换为 TypeScript 接口类型、请求参数类型和响应类型，并支持输出格式与命名风格配置",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=openapi-to-typescript-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

列出可用工具

连接到 SSE 端点后，列出已开放的工具：

tools/list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

调用此工具

通过工具 id 调用，参数由其参数表构建：

tools/call

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "openapi-to-typescript-generator",
    "arguments": {
  "specInput": "openapi: 3.0.0\ninfo:\n  title: User API\n  version: 1.0.0\npaths:\n  /users/{id}:\n    get:\n      operationId: getUser\n      parameters:\n        - in: path\n          name: id\n          required: true\n          schema:\n            type: string\n      responses:\n        \"200\":\n          description: ok\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/User\"\ncomponents:\n  schemas:\n    User:\n      type: object\n      required: [id, name]\n      properties:\n        id:\n          type: string\n        name:\n          type: string",
  "sourceFormat": "yaml",
  "outputFormat": "flat",
  "namingStyle": "pascal",
  "declarationStyle": "interface",
  "namespaceName": "Api",
  "includeOperationTypes": true,
  "includeDescriptions": true
}
  }
}

可用逗号分隔的 toolId 在一个会话中串联多个工具，例如 /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp（最多 20 个）。

有问题或反馈？请联系 [email protected]