LLM 文档集成

约 588 字大约 2 分钟

2025-03-27

PingPongCheckout 文档站支持 llms.txt 协议，允许 AI 编程工具直接获取 API 文档，提供更准确的代码建议和 API 调用辅助。

什么是 llms.txt

llms.txt 是一个专为 LLM（大语言模型）设计的文档标准，提供结构化的文档索引，让 AI 工具能够：

快速发现文档结构
获取特定 API 的详细说明
理解参数定义和响应格式

文件位置

文件	路径	说明
llms.txt	`/llms.txt`	语言索引入口，指向中英文发现文件
中文 llms.txt	`/zh/llms.txt`	中文文档目录索引（简洁版）
英文 llms.txt	`/en/llms.txt`	英文文档目录索引（简洁版）
llms-full.txt	`/llms-full.txt`	完整版语言索引入口
中文 llms-full.txt	`/zh/llms-full.txt`	中文完整文档内容
英文 llms-full.txt	`/en/llms-full.txt`	英文完整文档内容
OpenAPI 规范	`/api/openapi.json`	OpenAPI 3.1.0 规范
API 索引	`/api/index.json`	所有 API 端点索引

AI 工具集成

Cursor

在项目根目录创建 .cursorrules 文件：

当需要调用 PingPongCheckout API 时，请参考以下文档：
- 中文文档索引：https://acquirer-api-docs-v4-en.pingpongx.com/zh/llms.txt
- OpenAPI 规范：https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

Windsurf

在 .windsurfrules 中添加：

PingPongCheckout API 文档：
- https://acquirer-api-docs-v4-en.pingpongx.com/zh/llms.txt
- https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

Claude Code

在 CLAUDE.md 中配置：

## API 文档参考

查阅 PingPongCheckout API 时：
1. 优先读取 /zh/llms.txt 获取中文文档目录
2. 读取 /api/openapi.json 获取 API 规范
3. 根据目录中的 .md 链接获取详细文档

通用 HTTP 访问

任何支持 HTTP 请求的 AI 工具都可以直接获取：

# 获取语言索引
curl https://acquirer-api-docs-v4-en.pingpongx.com/llms.txt

# 获取中文文档目录
curl https://acquirer-api-docs-v4-en.pingpongx.com/zh/llms.txt

# 获取 OpenAPI 规范
curl https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

# 获取 API 索引
curl https://acquirer-api-docs-v4-en.pingpongx.com/api/index.json

API 规范文件

OpenAPI 规范

/api/openapi.json 包含完整的 OpenAPI 3.1.0 规范：

所有 API 端点定义
请求参数和响应格式
认证方式说明
错误码定义

API 索引

/api/index.json 提供 API 端点快速索引：

{
  "version": "1.0.0",
  "count": 37,
  "apis": [
    {
      "id": "zh-v4-payment-prePay",
      "name": "prePay（预下单）接口",
      "path": "/v4/payment/prePay",
      "method": "POST",
      "jsonUrl": "/api/zh/zh-v4-payment-prePay.json",
      "mdUrl": "/api/zh/zh-v4-payment-prePay.md"
    }
  ]
}