agentsclimarketplace

Api docs

Skill xiongxianzhu/xskills/skills/api-docs

个人创建的skills及推荐一些好用的skills

Install
npx -y skills add xiongxianzhu/xskills --skill api-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

按项目规范编写 API 文档。使用场景：用户要求写接口文档、补充 API 说明、为第三方或内部接口编写文档时。

SKILL.md

1.0 KB, as published. Nobody here has run it

API 文档（api-docs）

按 references/specification.md 编写 API 文档，保证格式统一、可供第三方或前端对接。

何时使用

  • 撰写、补充或修订接口说明、对接文档
  • 为第三方或内部调用方提供可实现的 API 描述

工作流程

  1. 从路由与实现代码提取真实路径、参数名、类型与错误码，避免编造字段。
  2. 遵守规范中的章节结构、表格列、Markdown 约束与「禁止省略」条款。
  3. 版式与接口小节写法对照 references/examples.md；若为已有文档增量编辑，保持与既有小节风格一致。

参考文件

  • references/specification.md — 章节结构、参数表约定与禁止省略规则
  • references/examples.md — 虚构「图书管理系统」完整示例

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.