跳到正文

发现与调用 API ​

以下示例使用 goodvision;项目内安装后使用 npx --no-install goodvision。安装与首次配置见快速开始。

bash
goodvision api products
goodvision api list
goodvision api search user context
goodvision schema resolveCustomerUserContext
goodvision api call resolveCustomerUserContext --config ./goodvision.json --input ./request.json --dry-run
goodvision api call resolveCustomerUserContext --config ./goodvision.json --input ./request.json

request.json 首次用户空间请求为:

json
{"body":{}}

通用输入支持 path、query、headers 和 body,只接受当前 Schema 登记的参数。每项操作显示产品、版本、所需身份与最小 Scope。所需 Application Header 可从当前配置补入,其他授权和领域引用仍按 API 提供。流式 API 加 --stream 输出逐行 JSON。

api list [product] 与 api search <关键词...> 可离线运行;搜索同时匹配操作 ID、产品、描述、路径、方法、身份和 Scope,忽略大小写,多个关键词须全部命中。按产品调用可使用 goodvision api <product> <operationId>。API 调用、事件便捷命令与 SDK 均消费同一 Owner 合同,不开放任意内部 URL。

--dry-run 只做本地校验和脱敏预览,不证明权限、费用或业务准入。普通输出为 {"ok":true,"data":...},错误写入 stderr 并返回非零退出码。退出码 3 表示身份或权限拒绝,4 表示版本、幂等或租约冲突,5 表示写入结果未知;输入或依赖错误返回 1。

写操作不自动重试。结果未知时保留原请求和幂等键,先按该 API 的查询/恢复合同确认结果;不得换新键再次提交。详见幂等与重试。

成功状态仍需符合当前 API 合同。未登记的成功状态或 JSON/SSE 响应类型错配会返回错误;写请求已发出时按结果未知处理,并保留允许公开的请求标识。仅支持 SSE 的操作漏加 --stream 会在联网前拒绝,补齐参数后再调用。

开发者文档。第三方接入不需要内部运营平台权限。