@goast/core

中文文档
0.7.1发布于 2026/10/17MITTypeScriptES Module构建来源已验证近 30 天下载 1.6万

A tool designed to transform OpenAPI specifications into various forms with flexibility and extensibility at its core.

原始使用文档
文档目录4 节
  1. Purpose 👍
  2. Usage Example 🚀
  3. Available Generator Packages 📚
  4. API Documentation 📖

gOAst (@goast/core)

@goast/core NPM Version

gOAst stands for generative Open API specification transformer, a tool designed to transform OpenAPI specifications into various forms with flexibility and extensibility at its core.

For more Information, please visit the gOAst GitHub Repository.

Purpose 👍

The @goast/core package provides:

  • entry points for using the gOAst library
  • base classes for creating custom generators
  • utilities for parsing and transforming OpenAPI specifications

Usage Example 🚀

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();

Available Generator Packages 📚

@goast/typescript NPM Version @goast/kotlin NPM Version

API Documentation 📖

The API documentation can be found here.

版本与发布记录

@goast/core 共发布 44 个版本,首次发布于 2023/06/13;过去 12 个月发布了 16 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.7.1latest2026/10/1730 天前
0.7.02026/10/151 个月前
0.7.0-beta.2next2026/10/151 个月前
0.7.0-beta.12026/10/151 个月前
0.6.02026/10/131 个月前
0.6.0-beta.22026/10/131 个月前

关于 @goast/core 的常见问题

@goast/core 是什么?

A tool designed to transform OpenAPI specifications into various forms with flexibility and extensibility at its core.

如何安装 @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 和提交记录判断。