SuperAPI AI 工具集

bruno-api

编程与开发

查看项目

更新于 10-15 18:45

技能介绍

用途:读取 Bruno(.bru)请求文件,把这些请求映射到 Django 后端实现,并输出结构化的 Markdown 接口文档。适用于已有 Bruno 接口集合、需要补齐后端实现说明与前端调用示例的团队。\n\n输入与模式:可指定单个 .bru 文件路径,或用 --scan <dir> 递归分析目录下全部 .bru 文件。可选 --dry-run 仅生成分析计划,不做深入代码检索;--output <path> 把生成的 Markdown 写入文件。输入缺失或含糊时,会先向用户确认分析哪些文件、是否预演、是否落盘。\n\n主要能力:解析 HTTP 方法、URL 路径、请求头、查询参数、路径参数、请求体并尽量推断结构;识别 JWT、会话 Cookie 或显式无鉴权等鉴权意图;收集 Bruno 测试/断言块作为测试线索。随后按仓库约定定位 Django 路由与实现:以 /api/v2/ 开头时检查 dashboardapp/v2_urls.py 与 dashboardapp/views/v2/;以 /api/v2/pulse/ 开头时检查 pulse_iq/api/ 中的 Django Ninja 路由器;否则检索各应用 urls.py 或按 URL 片段 Grep。定位后识别实现类型(DRF 的 View/ViewSet、序列化器、权限与过滤,或 Ninja 的路由器、Pydantic schema、鉴权与多租户作用域),并记录代码引用(path/to/file.py:123)。\n\n文档结构:按端点生成单个 Markdown,包含方法/URL、鉴权、权限与多租户、Overview、请求、响应(含常见错误)、实现细节、业务逻辑(含任务、邮件、Webhook 等副作用)、前端集成(TypeScript 类型与调用示例)、测试与 Notes。仅在影响正确性/完整性时使用 [BLOCKING]、[SHOULD_FIX]、[NOTE] 标记。\n\n用法:Claude Code 用 /plugin install bruno-api@diversiotech 安装后以 /bruno-api:docs 调用;Codex 用 skill-installer 安装 --repo DiversioTeam/agent-skills-marketplace --path plugins/bruno-api/skills/bruno-api,再以 $skill bruno-api 调用。\n\n限制:具体实现细节、动态响应结构与价格、平台等信息暂未提供;文档质量依赖 Bruno 文件与后端代码的可访问性,不确定处会标注假设。