@ forge-ts/ api (帮助)

OpenAPI 3.2 光谱和 API 参考生成器 伪造 工具链.

何时使用此软件包

大多数用户应安装 @forge-ts/cli 换成 和使用情况 npx forge-ts build。本包供方案使用.

npm install @forge-ts/api

它会产生什么

• OpenAPI 3.2 JSON (英语) 从您的导出界面、 类型、 类和 enums
• 类型图示 - 已映射到 OpenAPI 计划的脚本签名
• 可见度过滤 - 说吧 @internal 符号从不以相片显示
• 结构化 API 参考 带有完整的TSDoc元数据

示例

import { loadConfig, createWalker } from "@forge-ts/core";
import { generateOpenAPISpec, extractSDKTypes } from "@forge-ts/api";

const config = await loadConfig();
const walker = createWalker(config);
const symbols = walker.walk();
const sdkTypes = extractSDKTypes(symbols);
const spec = generateOpenAPISpec(config, sdkTypes);

// spec is a fully typed OpenAPIDocument
console.log(JSON.stringify(spec, null, 2));

伪造的一部分

见 主还原 用于完整文档.

许可证

麻省理工学院