← 返回 Skills 市场

Api Push Frontend

Name: Api Push Frontend
Author: snowzhouj

作者 SnowZhouJ · GitHub ↗ · v1.0.0 · MIT-0

cross-platform ⚠ pending

总下载

当前安装

版本数

在 OpenClaw 中安装

/install api-push-frontend

功能描述

推送后端 API 接口定义到前端数据接口平台。

使用说明 (SKILL.md)

API Push Frontend

将后端 API 接口定义（请求方法、路径、参数、响应结构）推送到前端数据接口平台，实现前后端接口文档同步。

触发场景

后端完成接口开发后推送到前端平台
批量推送、增量更新、推送历史查询

核心信息

推送地址: https://jffe.techgp.cn/md/api/uploadV4
方法: POST
Content-Type: application/json
必填参数: prdId (产品需求 ID), apis (接口定义数组)

工作流程

获取产品需求 ID（prdId）
准备接口定义（JSON/Swagger/自然语言）
执行推送脚本或 API 调用
验证推送结果
记录推送历史到 references/push-history.md

使用方式

自然语言（推荐）：直接告诉我需求，我引导你完成推送

脚本方式：

python3 scripts/push_api_to_frontend.py --prdId "PRD-2026-001" --file ./api-definitions.json

直接 API：参考 references/frontend-api-docs.md

接口定义格式

支持：

标准 JSON 格式
Swagger/OpenAPI 3.0
Spring Boot Controller 注解
Java 接口描述

详细格式规范见 references/api-definition-standard.md

错误处理

常见错误码：

400: 参数格式错误 → 检查 JSON 格式和必填字段
401: 认证失败 → 检查认证 token
404: prdId 不存在 → 确认产品需求 ID
500: 服务器错误 → 联系平台管理员

推送前验证、网络错误重试（最多 3 次）、记录详细错误日志。

最佳实践

推送前检查：接口定义完整、参数清晰、响应结构明确
批量推送：按模块分组，每次 \x3C 50 个接口
版本管理：标注新增/修改/废弃接口
通知前端：推送完成后提供变更说明

详细实践见 references/frontend-api-docs.md

自动化集成

支持 CI/CD 集成和 Git Hook 集成，配置示例见 references/frontend-api-docs.md

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install api-push-frontend
安装完成后，直接呼叫该 Skill 的名称或使用 /api-push-frontend 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.0

- 初始版本发布，实现后端 API 接口定义一键推送到前端数据接口平台。 - 支持自然语言描述、脚本调用和直接 API 三种推送方式。 - 明确接口规范，支持 JSON、Swagger/OpenAPI、Spring Boot 注解等格式。 - 完善错误处理与推送历史记录，提供最佳实践和自动化集成建议。 - 提供详细文档与使用指引，便于前后端接口文档同步。

元数据

Slug api-push-frontend

版本 1.0.0

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 1

常见问题