agent-api-doc-generator
SKILL.md
Agent API Doc Generator (智能体平台专属 API 文档生成器)
业务背景
随着网易云信“情感陪伴智能体”和“网易小派”业务的快速迭代,服务端 API 的新增和变更非常频繁。之前整理过一个通用的API文档生成器,这次为了保证对外输出的 API 文档(如《创建智能体》、《查询历史对话》等)风格高度统一,且公共链接(如请求头、错误码)绝对准确,我专门为**智能体平台(Agent Platform)**定制了这款文档生成器。
Skill 简介
与通用的 API 文档生成器不同,本 Skill 是智能体平台专属的。它内置了智能体平台的专属领域知识:
- 专属 Endpoint:自动注入
https://rtc-agent.yunxinapi.com/v1。 - 专属文档链接:自动绑定智能体平台特有的 [请求结构] 和 [错误码] 文档锚点。
- 专属 SEO 关键词:自动注入
AI硬件,RTC,音视频通话,Agent 创建,AI 语音助手,实时通信,智能语音等关键词。
研发只需输入 API 名称、路径和 JSON 示例,即可一键生成完全符合智能体平台规范的 Markdown 文档。
为什么这个 Skill 极具业务价值?
- 极致的垂直领域优化:去掉了通用生成器中冗余的路由判断逻辑,专为当前核心业务(智能体)服务,生成速度更快,准确率 100%。
- 降低认知负担:研发同学不需要去查阅“智能体平台的错误码链接是哪个”,Skill 已经全部内置。
- 开箱即用:生成的 Markdown 可以直接复制粘贴到外部文档中心(如网易云信文档中心)发布。
测试运行
python skill.py
python3 skill.py