# @pigeonposse/api-2026 中文文档

规范地址：https://npmcn.com/package/%40pigeonposse/api-2026/

版本：1\.0\.3
npm 元数据更新时间：2026-11-02T03:34:02.284Z
中文译文更新时间：2026-11-02T04:29:01.290Z
软件包许可：GPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40pigeonposse/api-2026
原文对照：https://npmcn.com/package/%40pigeonposse/api-2026/?lang=original
源码仓库：https://github.com/pigeonposse/pigeon-web

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

- 包体积（解压后）：53.5 kB，42 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-11-02T02:42:18.048Z
- 最新版本发布：2026-11-02T03:34:01.947Z
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

用于PigeonPosse web 2026的API

## 安装

```sh
npm install @pigeonposse/api-2026
```

也可以使用：`pnpm add @pigeonposse/api-2026`、`yarn add @pigeonposse/api-2026`、`bun add @pigeonposse/api-2026`

## README

# PIGEONPOSSE API

![HEADER](https://raw.githubusercontent.com/pigeonposse/pigeon-web/main/docs/public/banner.png)

运行PigeonPosse API。

Rest API从GitHub存储库获取数据。

-   所需 [@pigeonposse / web - 2026](https://www.npmjs.com/package/@pigeonposse/web-2026)

## 先决条件

-   GitHub令牌 [阅读更多](https://github.com/settings/tokens)

## 安装

```bash
npm i @pigeonposse/api-2026
# or
pnpm i @pigeonposse/api-2026
```

## CLI使用

```bash
GH_TOKEN="your-github-token" GH_USER="your-github-user" npx @pigeonposse/api-2026
# or
GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpx @pigeonposse/api-2026
```

或者安装

```bash
npm i @pigeonposse/api-2026
GH_TOKEN="your-github-token" npm exec pigeonposse-api-2026
# or
pnpm i @pigeonposse/api-2026
GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpm exec pigeonposse-api-2026
```

## 图书馆的使用

### 标准的服务器

```js
import { createServer } from '@pigeonposse/api-2026' // OR: import { createServer } from '@pigeonposse/api-2026/server'
createServer( {
 DEBUG: 'false',
 GH_TOKEN: "your-github-token",
 GH_USER: 'angelespejo',
 GH_BRANCH: 'main',
 GH_USER_TYPE: 'user',
 API_PORT: 1312,
 API_STORE_PATH: 'build/store/pigeonposse.json'
} )
```

```bash
node standard-server.js
## Override OPTION
DEBUG=true node standard-server.js
```

### 本地服务器

```js
import { createLocalServer } from '@pigeonposse/api-2026' // OR: import { createLocalServer } from '@pigeonposse/api-2026/server'

createLocalServer( {
 DEBUG: 'false',
 GH_TOKEN: "your-github-token",
 GH_USER: 'angelespejo',
 GH_BRANCH: 'main',
 GH_USER_TYPE: 'user',
 API_PORT: 1312,
 API_STORE_PATH: 'build/store/pigeonposse.json'
} )
```

```bash
node local-server.js
## Override OPTION
DEBUG=true node local-server.js
```

### 自定义服务器

您可以只使用应用程序，以建立您的服务器，无论你想要的。

### 标准的应用

```js
import { appStandard } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/standard'

// Build you server
```

### 本地应用程序

```js
import { appLocal } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/local'

// Build you server
```

### 更改环境变量

```js
import { ENV } from '@pigeonposse/api-2026' // OR: import { ENV } from '@pigeonposse/api-2026/env'

ENV.DEBUG = 'true'
ENV.GH_USER='angelespejo'
ENV.GH_BRANCH='main'
ENV.GH_USER_TYPE='user'

// Do something
```

## 在存储库中添加自定义配置

这个包使用Collectium Github Preset来获取Github数据。有关更多信息，请阅读 [文档](https://collectium.pigeonposse.com/guide/preset/github/)

## 常见问题

### @pigeonposse/api-2026 是什么？

用于PigeonPosse web 2026的API

### 如何安装 @pigeonposse/api-2026？

在项目目录运行 npm install @pigeonposse/api-2026，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 pigeonposse-api、pigeonposse-api-2026，可以用 npx pigeonposse-api 直接运行。

### @pigeonposse/api-2026 支持 TypeScript 吗？

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

### @pigeonposse/api-2026 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @pigeonposse/api-2026 可以商用吗？

@pigeonposse/api-2026 使用 GPL-3\.0-only 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @pigeonposse/api-2026 还在维护吗？

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