> 功能说明: 本技能涵盖 自动化配置和灵活的参数设置、工作流程和效率、时使用、化配置和灵活的参数设置 等核心能力。
> 功能说明: 本技能涵盖 映射为 等核心能力。
magic-api-generate
能力梳理
详见参考文档:
- 语法参考 - 完整语法、内置函数、模块导入
- 数据库操作 - 多数据源、分页、事务
- 业务示例 - 登录认证、文件上传、导出等
- 针对
语法参考(/api/v1/skills/magic-api-generate/file?md&ownerHandle=webx32),解析输入数据并返回响应 - 验证返回数据的完整性和格式正确性
数据库操作(/api/v1/skills/magic-api-generate/file?md&ownerHandle=webx32)
针对数据库操作(/api/v1/skills/magic-api-generate/file?
输入: 用户提供数据库操作(/api/v1/skills/magic-api-generate/file?
输出: 返回数据库操作(/api/v1/skills/magic-api-generate/file?
- 针对数据库操作(/api/v1/skills/magic-api-generate/file?md&ownerHandle=webx32),解析输入数据并返回响应
- 验证返回数据的完整性和格式正确性
业务示例(/api/v1/skills/magic-api-generate/file?md&ownerHandle=webx32)
针对业务示例(/api/v1/skills/magic-api-generate/file?
输入: 用户提供业务示例(/api/v1/skills/magic-api-generate/file?
输出: 返回业务示例(/api/v1/skills/magic-api-generate/file?
- 针对业务示例(/api/v1/skills/magic-api-generate/file?md&ownerHandle=webx32),解析输入数据并返回响应
- 验证返回数据的完整性和格式正确性
场景示例
| 场景 | 输入 | 输出 |
|---|---|---|
| 接口开发 | 接口路径与业务逻辑脚本 | 自动映射的HTTP接口 |
| 数据库操作 | SQL与数据源配置 | 多数据源查询/分页/事务结果 |
| 业务实现 | 登录认证/文件上传/导出需求 | 可运行的magic-api脚本 |
不适用于:需要人工判断的复杂决策场景
操作步骤
依赖说明
运行环境
- Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
- 操作系统: Windows / macOS / Linux
第三方依赖
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|---|---|---|---|
| LLM API | API | 必需 | 由Agent内置LLM提供 |
API Key 配置
可用性分类
- 分类: MD+execute()
- 说明: 基于Markdown的AI Skill,
API Key配置方式:
export API_KEY="${API_KEY:?请设置环境变量}"
配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.
参数说明
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| content | string | 否 | 处理的内容输入 |
| mode | string | 否 | 处理模式, 可选值: json/text/markdown |
| style | string | 否 | 输出风格, 参考 references/style.md |
输出说明
{
"success": true,
"data": {
"result": "处理结果",
"status": "success",
"metadata": {
"metadata": {
"template_used": "reviewer",
"word_count": 0,
"style": "专业"
}
},
"error": null
}
输出模板参考: assets/output.json
依赖说明(补充)
| 依赖项 | 类型 | 必需 | 说明 |
|---|---|---|---|
| LLM | 模型 | 是 | 需要LLM进行内容生成, 推荐GPT-4/智谱GLM-4/DeepSeek |
| API Key | 凭证 | 否 | 使用云端LLM时需要, 本地LLM不需要 |
国内替代方案:
- OpenAI GPT → 智谱GLM-4 / 百度文心一言 / 通义千问 / DeepSeek
- OpenAI Embedding → 智谱embedding-2 / 百度embedding
案例展示
示例1:基础用法
# 请参考上方使用说明进行配置和调用
result = "ready"
```xml
<dependency>
<groupId>org.ssssssss</groupId>
<artifactId>magic-api-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
请参考上方使用说明进行配置和调用
result = "ready"
server:
port: 9999
magic-api:
web: /magic/web # Web UI 入口
resource:
location: /data/magic-api # 脚本存储位置(可改为 classpath: 只读模式)
请参考上方使用说明进行配置和调用
result = "ready"
http://localhost:9999/magic/web
请参考上方使用说明进行配置和调用
result = "ready"
```
热门问题
Q1: 如何开始使用magic-api-generate?
A: 请参考使用流程和依赖说明章节,确保运行环境满足要求后调用本技能。
故障处理体系
| 错误场景(续) | 原因 | 处理方式 |
|---|---|---|
| LLM响应超时或无响应 | 网络延迟或模型负载过高 | 请求重试;确认Agent平台LLM服务正常 |
| 输入内容格式不正确 | 用户输入不符合skill预期格式 | 检查输入是否符合skill使用说明中的格式要求,参考示例章节 |
| 执行结果与预期不符 | 指令描述不够明确或上下文不足 | 提供更详细的指令描述,补充必要的上下文信息 |
| 命令执行失败 | 运行环境不满足要求或权限不足 | 确认运行环境符合依赖说明中的要求;检查命令权限设置 |
能力边界
- 安全性 - 生产环境关闭 Web UI 或限制 IP 访问
- 版本控制 - 脚本目录建议 Git 管理
- 密码加密 - 使用 MD5/BCrypt,不要明文存储
- SQL 注入 - 使用参数化查询
?占位符 - 性能 - 复杂逻辑拆分多个接口,避免单脚本过长
创新特色
效率提升量化分析
| 操作步骤 | 手动耗时 | 自动化耗时 | 时间节约 | 准确率提升 |
|---|---|---|---|---|
| 接口设计 | 2天 | 30分钟 | 1.5天 | 5% |
| 数据库操作 | 1天 | 2小时 | 0.5天 | 3% |
| 业务逻辑实现 | 3天 | 4小时 | 2.5天 | 4% |
| 接口测试 | 1天 | 1小时 | 0.5天 | 2% |
| 文档编写 | 1天 | 30分钟 | 0.5天 | 1% |
差异化对比
| 对比维度 | 本技能 | 手动操作 | Python脚本 | 专业软件 |
|---|---|---|---|---|
| 易用性 | 高 | 低 | 中 | 高 |
| 速度 | 快 | 慢 | 中 | 快 |
| 成本 | 低 | 高 | 中 | 高 |
| 功能丰富性 | 高 | 低 | 中 | 高 |
| 学习曲线 | 低 | 高 | 中 | 高 |
核心痛点解决
| 痛点 | 描述 | 影响范围 | 解决方案 | 量化效果 |
|---|---|---|---|---|
| 接口开发效率低 | 需要手动编写大量代码,耗时且易出错 | 整个开发周期 | 使用API自动生成工具,提高开发效率 | 提高约30% |
| 数据库操作复杂 | 需要手动编写SQL语句,易出错且效率低 | 数据库操作过程 | 提供数据库操作功能,简化操作流程 | 提高约50% |
| 业务逻辑实现困难 | 需要编写复杂的业务逻辑代码 | 业务逻辑实现 | 提供业务示例和语法参考,降低实现难度 | 提高约40% |
常见问题FAQ
Q1: magic-api-generate是否支持多种编程语言?
A: magic-api-generate主要支持JavaScript,但可以通过插件扩展支持其他编程语言。
Q2: magic-api-generate如何处理异常情况?
A: magic-api-generate提供了异常处理机制,当出现异常时,会返回错误信息,并记录到日志中。
Q3: magic-api-generate是否支持跨域请求?
A: magic-api-generate支持跨域请求,但需要配置CORS策略。
Q4: magic-api-generate如何进行性能优化?
A: magic-api-generate提供了多种性能优化方法,如缓存、异步处理等。
Q5: magic-api-generate如何进行安全防护?
A: magic-api-generate提供了安全防护措施,如输入验证、权限控制等。
安全合规声明
- 确保API密钥安全,避免泄露。
- 对输入数据进行验证,防止输入验证等攻击。
- 设置合理的权限控制,防止未授权访问。
- 定期更新依赖库,避免安全漏洞。
- 对敏感数据进行加密处理,确保数据安全。