Files
claude-howto/zh/01-slash-commands/generate-api-docs.md
T
Luong NGUYEN 89e89d4aa3 feat(zh): add Chinese translations in zh/ directory
Add Chinese (Simplified) translations for all documentation, organized
under a dedicated zh/ directory that mirrors the English folder structure.

Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com>

Translations originally contributed by @tanqingkuang in #45.
Restructured from *-CN.md suffix pattern into zh/ directory to prevent
the EPUB builder (scripts/build_epub.py collect_folder_files) from
picking up Chinese files via glob("*.md") inside module folders.
2026-04-06 23:08:54 +02:00

448 B

description
description
根据源代码生成完整的 API 文档

API 文档生成器

按以下步骤生成 API 文档:

  1. 扫描 /src/api/ 下的所有文件
  2. 提取函数签名和 JSDoc 注释
  3. 按端点/模块进行组织
  4. 生成带示例的 Markdown
  5. 包含请求/响应 Schema
  6. 添加错误文档

输出格式:

  • 输出为 /docs/api.md 中的 Markdown 文件
  • 为所有端点加入 curl 示例
  • 添加 TypeScript 类型