# @goast/core 中文文档

规范地址：https://npmcn.com/package/%40goast/core/

版本：0\.7\.1
npm 元数据更新时间：2026-10-17T11:19:21.705Z
中文译文更新时间：2026-11-16T17:33:48.778Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40goast/core
原文对照：https://npmcn.com/package/%40goast/core/?lang=original
项目主页：https://github.com/MaSch0212/goast#readme
源码仓库：https://github.com/MaSch0212/goast

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：392 kB，97 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2023-06-13T07:01:39.705Z
- 最新版本发布：2026-10-17T11:19:21.367Z
- 近 30 天下载量：15741（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 16 个）

## 中文简介

一个旨在将OpenAPI规格转化为以灵活性和可扩展性为核心的各种形式的工具.

## 安装

```sh
npm install @goast/core
```

也可以使用：`pnpm add @goast/core`、`yarn add @goast/core`、`bun add @goast/core`

## README

# gOAst (@goast/ core) (中文(简体) )

[![@goast/core NPM Version](https://img.shields.io/npm/v/%40goast%2Fcore?logo=npm&label=%40goast%2Fcore)](https://www.npmjs.com/package/@goast/core)

**目标** 代表着 **页:1**启动 **欧**笔 **A 类**个人信息 **编号**修饰 **页:1**ransformer,一个用于转换的工具 OpenAPI规格分为多种形式,其核心具有灵活性和可扩展性.

详情请访问 [gOst GitHub 仓库](https://github.com/MaSch0212/goast/blob/main)。 。 。 .

## 目标

这个 `@goast/core` 软件包提供:

-   使用 **目标** 图书馆
-   创建自定义生成器的基础类
-   openAPI 规格的解析和转换

## 用法示例 QQ

```typescript
import { OpenApiGenerator } from '@goast/core';

class MyGenerator implements OpenApiGenerationProvider {
  generate(
    context: OpenApiGeneratorContext<OpenApiGeneratorInput>,
    config?: Partial<Readonly<Record<string, unknown>>>,
  ): Record<string, unknown> {
    // Do something
    return {};
  }
}

async function main() {
  const generator = new OpenApiGenerator()
    // Add a generator using a class
    .useType(MyGenerator)
    // Add a generator using a function
    .useFn((ctx, cfg) => {
      // Do the generation
      return {}; // Return information about the generated files so it can be used by other generators
    })
    // Add a generator using an object implementing `OpenApiGenerationProvider`
    .useValue({ generate: (ctx, cfg) => ({}) });

  // Generate for one of more OpenAPI specification files
  await generator.parseAndGenerate('path/to/openapi.json', 'path/to/another/openapi.yaml');

  // Alternatively, you can generate output for all specifications in a directory.
  // By default, it will only consider files within the directory (non-recursively) with the extensions: .json, .yaml, .yml.
  await generator.parseAndGenerateFromDir('path/to/openapi/specs');
}

main();
```

## 可用的生成器软件包

[![@goast/typescript NPM Version](https://img.shields.io/npm/v/%40goast%2Ftypescript?logo=npm&label=%40goast%2Ftypescript)](https://www.npmjs.com/package/@goast/typescript) [![@goast/kotlin NPM Version](https://img.shields.io/npm/v/%40goast%2Fkotlin?logo=npm&label=%40goast%2Fkotlin)](https://www.npmjs.com/package/@goast/kotlin)

## API 文档 QQ

API 文档可见 [这里](https://github.com/MaSch0212/goast/wiki)。 。 。 .

## 常见问题

### @goast/core 是什么？

一个旨在将OpenAPI规格转化为以灵活性和可扩展性为核心的各种形式的工具\.

### 如何安装 @goast/core？

在项目目录运行 npm install @goast/core，或使用 pnpm add / yarn add / bun add。

### @goast/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @goast/core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @goast/core 可以商用吗？

@goast/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @goast/core 的下载量有多少？

根据 npm 官方下载统计，@goast/core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 15,741 次，日均约 525 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @goast/core 还在维护吗？

最新版本 0\.7\.1 发布于 2026/10/17（30 天前）；至今共发布 44 个版本，其中过去 12 个月发布了 16 个；首次发布于 2023/06/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

