@ankhorage/api

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

框架中立可执行的API运行时间和Ankhorage的运输合同.

中文使用文档
文档目录4 节
  1. 使用量
  2. 国 际
  3. 基本用途
  4. 生成的文件

@ankhorage/ api (英语)

license: MIT npm: v0.3.1 runtime: bun typescript: strict eslint: checked prettier: checked build: checked tests: checked paradox: canonical

Ankhorage 的框架中立可执行的 API 运行时间 .

使用量

国 际

Ankhorage 包通过命令行界面曝光 ankh启用 ankh --help 来发现可用的软件包命令,或用 --help 用于特定软件包.

# Install the Ankhorage CLI
bun add --global @ankhorage/ankh

# Show usage information for api
ankh api --help

基本用途

@ankhorage/api 执行便携式的 REST API 内部定义,而不连接应用程序 处理器以快捷化, Next.js, 或另一个 HTTP 框架 。 框架软件包 移动边缘的响应, 而运行时间拥有操作的搜索和发送.

const definition = {
  id: "health-api",
  origin: "internal",
  protocol: "rest",
  basePath: "/api",
  endpoints: {
    health: {
      id: "health",
      kind: "http",
      operations: {
        "health.read": {
          id: "health.read",
          protocol: "http",
          intent: "read",
          method: "GET",
          path: "/health",
        },
      },
    },
  },
} satisfies InternalRestApiDefinition;

生成的文件

版本与发布记录

@ankhorage/api 共发布 3 个版本,首次发布于 2026/10/04;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.1latest2026/10/1620 天前
0.3.02026/10/1620 天前
0.2.02026/10/041 个月前

关于 @ankhorage/api 的常见问题

@ankhorage/api 是什么?

框架中立可执行的API运行时间和Ankhorage的运输合同.

如何安装 @ankhorage/api?

在项目目录运行 npm install @ankhorage/api,或使用 pnpm add / yarn add / bun add。

@ankhorage/api 支持 TypeScript 吗?

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

@ankhorage/api 支持 ESM 还是 CommonJS?

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

@ankhorage/api 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@ankhorage/api 可以商用吗?

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

@ankhorage/api 的下载量有多少?

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

@ankhorage/api 还在维护吗?

最新版本 0.3.1 发布于 2026/10/16(20 天前);至今共发布 3 个版本,其中过去 12 个月发布了 3 个;首次发布于 2026/10/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。