API Doc Writer — API接口文档助手

Name: API Doc Writer — API接口文档助手
Author: yongjie666888

yongjie666888

API Doc Writer — API接口文档助手

v1.0.1

用于编写REST API文档、定义接口规范、生成接口说明。帮助开发者快速创建API文档，包括接口模板、设计指南和示例。

0· 772·0 当前·0 累计

by @yongjie666888·MIT-0

API工具文档工具文件处理代码生成

下载技能包

License

MIT-0

最后更新

2026/3/25

安全扫描

VirusTotal

无害

查看报告

OpenClaw

安全

high confidence

此技能仅提供API文档模板和指南，无需凭证、不安装任何内容，仅生成文档。其声明与实际行为完全一致。

评估建议

此技能看似无害，主要用于文档辅助。安装前请注意：（1）来源未知，建议从可信作者或有主页的技能中选择；（2）永远不要在示例请求中输入真实秘密或生产令牌；（3）review生成的文档以确保符合组织政策；（4）如果技能后续请求环境变量或运行代码，请重新评估权限。总体低风险。...

详细分析 ▾

✓ 用途与能力

名称和描述（API文档撰写助手）与SKILL.md内容一致，包括REST API文档模板、示例和指南。无不相关的能力或外部服务请求。

✓ 指令范围

SKILL.md仅包含API文档模板、示例和设计指南，不指示代理运行命令、读取文件、访问环境变量或联系外部端点。

✓ 安装机制

无安装规范或代码文件。仅提供指令意味着没有内容写入磁盘或安装，这是最低风险的安装模型。

✓ 凭证需求

技能未声明任何必需的环境变量、凭证或配置路径。没有不当或未解释的秘密访问请求。

✓ 持久化与权限

always:false 和默认调用设置。技能未请求持久/系统级权限或对其他技能或配置的修改。

安全有层次，运行前请审查代码。

License

MIT-0

可自由使用、修改和再分发，无需署名。

查看条款 ↗

运行时依赖

无特殊依赖

版本

latestv1.0.12026/3/25

● 无害

安装命令点击复制

官方npx clawhub@latest install api-doc-writer

镜像加速npx clawhub@latest install api-doc-writer --registry https://cn.clawhub-mirror.com

技能文档

API文档模板

... （由于原文内容较长，仅提供开头，实际内容应完全保留原SKILL.md中的Markdown格式和内容，不进行翻译）

API文档模板

# API接口文档
版本：V1.0
更新日期：YYYY-MM-DD
维护人：XXX
接口概览
模块 接口数 负责人
用户模块 5 @xxx
订单模块 8 @xxx
支付模块 4 @xxx
通用说明
认证方式

Authorization: Bearer


请求格式

Content-Type: application/json


响应格式

json { "code": 0, "message": "success", "data": {} }

状态码状态码说明 0 成功 1001 参数错误 2001 未授权 3001 资源不存在 5001 服务器错误接口详情 1. 用户接口 1.1 获取用户信息

接口地址

GET /api/v1/users/{id}


请求参数
参数名 类型 位置 必填 说明
id long path 是 用户ID
请求示例

GET /api/v1/users/123


响应示例

json { "code": 0, "message": "success", "data": { "id": 123, "name": "张三", "email": "zhangsan@example.com", "phone": "13800138000", "created_at": "2024-01-01 10:00:00" } }


错误示例

json { "code": 3001, "message": "用户不存在", "data": null }

1.2 创建用户

接口地址

POST /api/v1/users


请求参数
参数名 类型 必填 说明
name string 是 用户名
email string 是 邮箱
phone string 否 手机号
password string 是 密码
请求示例

json { "name": "张三", "email": "zhangsan@example.com", "phone": "13800138000", "password": "123456" }


响应示例

json { "code": 0, "message": "success", "data": { "id": 123, "name": "张三" } }

2. 订单接口 2.1 订单列表

接口地址

GET /api/v1/orders


请求参数
参数名 类型 位置 必填 说明
page int query 否 页码，默认1
page_size int query 否 每页数量，默认20
status string query 否 订单状态
请求示例

GET /api/v1/orders?page=1&page_size=10&status=paid


响应示例

json { "code": 0, "message": "success", "data": { "total": 100, "page": 1, "page_size": 10, "list": [ { "id": "ORD202401010001", "user_id": 123, "amount": 100.00, "status": "paid", "created_at": "2024-01-01 10:00:00" } ] } }


接口变更记录
版本 日期 变更内容 变更人
V1.0 YYYY-MM-DD 初始版本 @xxx
V1.1 YYYY-MM-DD 新增xxx接口 @xxx

接口设计原则

RESTful规范

方法	用途	示例
GET	查询	GET /users
POST	创建	POST /users
PUT	完整更新	PUT /users/1
PATCH	部分更新	PATCH /users/1
DELETE	删除	DELETE /users/1

URL命名规范

- 使用名词复数：/users
使用小写：/user-info
使用连字符分隔：/order-details
避免动词：不用 /getUser

状态码规范

类别	状态码	说明
1xx	信息	接收的请求正在处理
2xx	成功	请求正常处理完毕
3xx	重定向	需要附加操作完成请求
4xx	客户端错误	请求有语法错误
5xx	服务器错误	服务器处理出错

安全建议

敏感信息加密传输
身份验证Token过期机制
接口调用频率限制
参数校验过滤

数据来源：ClawHub ↗ · 中文优化：龙虾技能库

OpenClaw 技能定制 / 插件定制 / 私有工作流定制

免费技能或插件可能存在安全风险，如需更匹配、更安全的方案，建议联系付费定制

了解定制服务

状态码	说明
0	成功
1001	参数错误
2001	未授权
3001	资源不存在
5001	服务器错误

参数名	类型	必填	说明
name	string	是	用户名
email	string	是	邮箱
phone	string	否	手机号
password	string	是	密码

参数名	类型	位置	必填	说明
page	int	query	否	页码，默认1
page_size	int	query	否	每页数量，默认20
status	string	query	否	订单状态

版本	日期	变更内容	变更人
V1.0	YYYY-MM-DD	初始版本	@xxx
V1.1	YYYY-MM-DD	新增xxx接口	@xxx

License

运行时依赖

版本

安装命令 点击复制

技能文档

API文档模板

API文档模板

接口概览

通用说明

认证方式

请求格式

响应格式

状态码

接口详情

1. 用户接口

1.1 获取用户信息

1.2 创建用户

2. 订单接口

2.1 订单列表

接口变更记录

接口设计原则

RESTful规范

URL命名规范

状态码规范

安全建议

安装命令点击复制