Overview
- Skill Key
- 9talk/ts-interface-miner
- Author
- 9talk
- Source Repo
- openclaw/skills
- Version
- -
- Source Path
- skills/9talk/ts-interface-miner
- Latest Commit SHA
- ebc46bec0f6b8a08aea6edefe7882b9edee5c4f1
一个专门用于分析 TypeScript (.ts/.tsx) 文件的智能助手。它能够根据用户提供的关键词(功能描述、函数名、API 路径),精准定位相关接口定义。该技能深度解析代码结构与注释(JSDoc/单行注释),提取请求方法、路径、参数细节、响应结构及状态码,最终生成结构清晰、信息完整的 Markdown 表格文档。
Stars
0
Installs
0
Status
ACTIVE
Visibility
PUBLIC
直接复制以下提示词,发送给你的 AI 助手即可完成安装。
请先检查是否已安装 SkillHub 商店,若未安装,请根据 https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/skillhub.md 安装 SkillHub 商店,然后安装 ts-interface-miner 技能。 若已安装,则直接安装 ts-interface-miner 技能。
# SKILL: ts-api-miner
## 1. 技能概述 (Overview)
**名称**: `ts-api-miner`
**描述**: 一个专门用于分析 TypeScript (`.ts`/`.tsx`) 文件的智能助手。它能够根据用户提供的关键词(功能描述、函数名、API路径),精准定位相关接口定义。该技能深度解析代码结构与注释(JSDoc/单行注释),提取请求方法、路径、参数细节、响应结构及状态码,最终生成结构清晰、信息完整的**Markdown 表格文档**。
**核心特点**:
- 🎯 **多维搜索**: 支持通过功能描述、函数名称、URL 路径三种方式定位接口。
- 📝 **注释优先**: 优先提取 JSDoc (`@param`, `@returns`, `@description`) 和行内注释作为字段说明;若注释与类型定义冲突,以注释为准并标记警告。
- 🔗 **类型追踪**: 自动展开引用的 Interface/Type,递归提取嵌套类型的注释信息。
- 📊 **标准化输出**: 强制使用 Markdown 表格展示请求参数与响应信息,便于阅读和复制。
## 2. 触发条件 (Trigger Conditions)
当用户输入满足以下任一场景时,激活此技能:
1. 用户提供了一段 TypeScript 代码片段或文件路径,并要求“查找接口”、“生成文档”或“分析 API"。
2. 用户提供了关键词(如 `"登录"`, `getUserInfo`, `/api/order`),要求寻找相关接口详情。
3. 用户询问特定功能的请求参数、响应结构或状态码。
## 3. 工作流程 (Workflow)
### 步骤 1: 定位与上下文识别 (Locate & Context)
- **扫描**: 在提供的代码上下文中搜索关键词。
- 匹配 URL 字符串 (e.g., `'/api/v1/user'`)。
- 匹配函数/常量名 (e.g., `fetchUserInfo`)。
- 匹配注释中的功能描述 (e.g., `// 获取用户详细信息`)。
- **锁定**: 确定目标函数体及其调用的 HTTP 客户端方法 (axios, fetch, request 等)。
### 步骤 2: 深度解析与提取 (Parse & Extract)
- **基础信息**: 提取 `Method` (GET/POST...), `Path`, `Source Location`。
- **请求参数提取**:
- **Query/Path Params**: 从 URL 模板或配置对象中提取。
- **Body**: 识别 POST/PUT/PATCH 请求的数据载荷。
- **类型展开**: 如果参数类型是自定义 Interface (如 `LoginReq`),深入其定义提取字段列表。
- **注释融合策略 (关键)**:
1. 检查函数上方的 JSDoc `/** ... */`。
2. 检查参数旁的 `@param name - description`。
3. 检查字段定义旁的行内注释 `// ...`。
4. **规则**: 若 TS 类型为 `optional (?)` 但注释注明“...
openstockdata
OpenClaw Skill for stock data analysis
capt-marbles
Generative Engine Optimization (GEO) for AI search visibility. Optimize content to appear in ChatGPT, Perplexity, Claude, and Google AI Overviews. Use when optimizing websites, pages, or content for LLM discoverability and citation.
capgoblin
Access unsecured credit lines for AI agents on the Arc Network using the Credex Protocol. Use for borrowing USDC against reputation, repaying debt to grow credit limits, providing liquidity as an LP, or managing cross-chain USDC via Circle Bridge. Triggers on "borrow from credex", "repay debt", "deposit to pool", "check credit status", "provide liquidity", or any credit/lending task on Arc.
capt-marbles
Control PhantomBuster automation agents via API. List agents, launch automations, get output/results, check status, and abort running agents. Use when the user needs to run LinkedIn scraping, Twitter automation, lead generation phantoms, or any PhantomBuster workflow.
camelsprout
DuckDB CLI specialist for SQL analysis, data processing and file conversion. Use for SQL queries, CSV/Parquet/JSON analysis, database queries, or data conversion. Triggers on "duckdb", "sql", "query", "data analysis", "parquet", "convert data".
camohiddendj
DuckDuckGo HTML search scraper CLI with JSON, CSV, OpenSearch, markdown, and compact outputs.