mcpField
Z
ziniao-openapi-explorer

ziniao-openapi-explorer

github.com/ziniao-openDevelopment85.0k installsUpdated 8w ago
Repository

About ziniao-openapi-explorer

ziniao-openapi-explorer is an Agent skill for exploring Zinia APIs when existing shortcuts do not cover a request. It requires selecting paths from a reference list and invoking them with ziniao-cli api, with dry-run available for preview.

Key features

  1. 01Check existing shortcuts
  2. 02Find API paths in the reference list
  3. 03Call APIs with ziniao-cli api
  4. 04Preview requests with dry-run
  5. 05Confirm intent before write operations

Use cases

  1. 01Call an endpoint without a shortcut
  2. 02Explore access-policy APIs
  3. 03Preview an API request before execution

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ziniao-open/skills --skill ziniao-openapi-explorer

After installing, type/ziniao-openapi-explorerin Claude Code to confirm it loaded.

Details

From the project README

API 探索

前置条件: 先阅读 ../ziniao-shared/SKILL.md。

当用户的需求无法被现有快捷命令覆盖时,使用本技能查找对应的 API 路径并通过 ziniao-cli api 裸调。

探索流程

Step 1: 确认现有命令不足
ziniao-cli department --help
ziniao-cli staff --help
ziniao-cli account --help
ziniao-cli device --help
ziniao-cli role --help

如果已有对应快捷命令,直接使用。

Step 2: 从路径清单定位 API

禁止猜测 API 路径,必须从以下清单中查找。

部门(5 个)✅ 全部已有快捷命令
操作路径快捷命令
列表/superbrowser/rest/v1/erp/department/listdepartment list
新增/superbrowser/rest/v1/erp/department/adddepartment create
修改/superbrowser/rest/v1/erp/department/updatedepartment update
删除/superbrowser/rest/v1/erp/department/deletedepartment delete
排序/superbrowser/rest/v1/erp/department/orderdepartment reorder
员工(5 个)✅ 全部已有快捷命令
操作路径快捷命令
列表/superbrowser/rest/v1/erp/staff/liststaff list
新增/superbrowser/rest/v2/erp/staff/addstaff create
修改/superbrowser/rest/v2/erp/staff/modifystaff update
状态/superbrowser/rest/v1/erp/staff/statusstaff enable/disable/remove
调岗/superbrowser/rest/v1/erp/staff/departmentstaff transfer
账号(23 个)— 仍有 4 个需用 api
分类路径前缀快捷命令
CRUD/superbrowser/rest/v1/erp/store/list|create|update/base|deleteaccount list/create/update/delete
缓存/superbrowser/rest/v1/erp/store/deletecookieapi
授权/superbrowser/rest/v1/erp/store/auth/add|delete|clean、/superbrowser/rest/v1/erp/user/stores、/superbrowser/rest/v1/erp/store/user/listaccount auth-*
授权查询/superbrowser/rest/v1/erp/store/auth/queryapi
用户账号/superbrowser/rest/v1/erp/store/list/by/userapi
附加信息/superbrowser/rest/v1/erp/store/addtionapi
标签/superbrowser/rest/v1/erp/tag/list、/superbrowser/rest/v1/store-tag/add|delete|rename|bind|unbind|replace|clear|remove|listaccount tag-*
设备(11 个)— 仍有 2 个需用 api
分类路径前缀快捷命令
查询/superbrowser/rest/v1/erp/ip/page、/superbrowser/rest/v1/erp/proxy/purchased_package_info、/superbrowser/rest/v1/erp/ip/historybinddevice list(price/history 用 api)
套餐/superbrowser/rest/v1/erp/package/newdevice plan-list
购买/superbrowser/rest/v1/erp/purchase|renewdevice purchase/renew
自有/superbrowser/rest/v1/erp/ip/self/add/new|edit/newdevice add-custom/update-custom
绑定/superbrowser/rest/v1/erp/ip/bind|unbind|renewaldevice bind/unbind/auto-renew
角色(7 个)✅ 全部已有快捷命令
操作路径快捷命令
列表/superbrowser/rest/v1/erp/per/role/listrole list
详情/superbrowser/rest/v1/erp/per/role/detailrole detail
新增/superbrowser/rest/v1/erp/per/role/addrole create
修改/superbrowser/rest/v1/erp/per/role/editrole update
分配/superbrowser/rest/v1/erp/staff/change/rolerole assign
用户角色/superbrowser/rest/v1/erp/staff/role/listrole staff-roles
权限列表/superbrowser/rest/v1/erp/per/permission/listrole permissions
访问策略(22 个)— 全部需用 api
分类路径
规则/superbrowser/rest/v1/erp/security/access_rule/list
规则/superbrowser/rest/v1/erp/security/access_rule/detail
规则/superbrowser/rest/v1/erp/security/access_rule/add
规则/superbrowser/rest/v1/erp/security/access_rule/edit
规则/superbrowser/rest/v1/erp/security/access_rule/delete
规则/superbrowser/rest/v1/erp/security/access_rule/active
规则成员/superbrowser/rest/v1/erp/security/access_rule/change_user
规则账号/superbrowser/rest/v1/erp/security/access_rule/change_account
规则账号/superbrowser/rest/v1/erp/security/access_rule/account/bindable_list
网页/superbrowser/rest/v1/erp/security/access_rule_url/list
网页/superbrowser/rest/v1/erp/security/access_rule_url/detail
网页/superbrowser/rest/v1/erp/security/access_rule_url/add
网页/superbrowser/rest/v1/erp/security/access_rule_url/edit
网页/superbrowser/rest/v1/erp/security/access_rule_url/delete
网页/superbrowser/rest/v1/erp/security/access_rule_url/change_group
网页分组/superbrowser/rest/v1/erp/security/access_rule_url_group/list
网页分组/superbrowser/rest/v1/erp/security/access_rule_url_group/add
网页分组/superbrowser/rest/v1/erp/security/access_rule_url_group/edit
网页分组/superbrowser/rest/v1/erp/security/access_rule_url_group/delete
账号策略/superbrowser/rest/v1/erp/security/access_rule/list/one_account
账号策略/superbrowser/rest/v1/erp/security/access_rule/account_ref/add_to_account
账号策略/superbrowser/rest/v1/erp/security/access_rule/account_ref/remove_from_account
Step 3: 使用 dry-run 探索
# 先预览请求
ziniao-cli api /superbrowser/rest/v1/erp/per/role/list --dry-run

# 确认后执行
ziniao-cli api /superbrowser/rest/v1/erp/per/role/list

安全规则

  • 禁止猜测 API 路径或参数,必须从清单中查找
  • 写入/删除类操作前确认用户意图
  • 建议先用 --dry-run 预览

参考

Comments

Markdown supported