工具

API 参考

面向当前 UAIX REST 表面的逐路由手册,包含起步请求、OpenAPI 导出以及面向验证器的机器入口。

  • 记录 UAIX-TOOL-0062
  • 路径 /zh-cn/tools/api-reference/
  • 使用 规范公共记录

文件状态

公共标准页面 作为当前公共标准记录的一部分在 UAIX 上发布
代码
UAIX-TOOL-0062
表面
工具
使用权
公开且可链接

如何使用本页

使用本页检查实时 REST 路由、OpenAPI 文档、可复制的机器接口起步请求以及参考 mock exchange。

实时路由

目录发现接入套件 JSON公开记录项

机器表面

先从目录开始,再进入接入套件、OpenAPI、验证与实时 mock exchange

本页用于避免实现方反向推断 WordPress REST 表面。先在这里解析实时路由,再进入接入包、验证、mock 响应测试、问题详情处理或包组装,而无需猜测。生成的 .uai 包文件是本地记忆与交接记录,不是 API 端点或托管执行路由。

先解析

目录与发现

在发起任何具体路由调用之前,目录与发现路由会先告诉自动化系统当前公开表面是什么。

描述契约

OpenAPI 与起步请求

请使用这里的实时 OpenAPI 导出与起步请求模式,而不要依赖抓取来的页面文案或过时笔记。

继续推进

接入、验证与可复用证据

当路由清单直接进入接入包、验证器运行、实时 mock 响应,或可随发布评审一起传递的一致性数据包时,它的价值最大。

搜索边界

HTML 页面用于说明;JSON 路由用于执行

机器 JSON 路由标记为不可索引的执行表面,并带有明确缓存策略,因此搜索和引用应优先使用面向人类的文档页面。

HTTP 失败

Problem JSON 是恢复契约

路由查找失败、格式错误的公共 POST 正文、正文大小限制和速率限制都会返回 RFC 9457 风格的 application/problem+json,并包含 UAIX 代码、重试指引、证据标记和安全港链接。

实时路由

目录当前公开标准清单。发现面向机器的路由清单。接入套件 JSON用于首次证明运行的已发布接入包。公开记录项实时 OpenAPI 3.1 导出。验证用于一致性检查的机器 POST 目标。模拟交换用于获取实时合规响应信封的机器 POST 目标。一致性包 JSON在一次响应中返回可复用的启动数据包。

证明路径

公开记录项

此处说明当前公开记录、证据路径和支持边界。

  1. 1公开记录项此处说明当前公开记录、证据路径和支持边界。
  2. 2公开记录项此处说明当前公开记录、证据路径和支持边界。
  3. 3公开记录项此处说明当前公开记录、证据路径和支持边界。
  4. 4此处说明当前公开记录、证据路径和支持边界。此处说明当前公开记录、证据路径和支持边界。
起步调用解析实时 REST 表面
curl -s https://uaix.org/wp-json/uaix/v1/catalog
curl -s https://uaix.org/wp-json/uaix/v1/discovery
curl -s https://uaix.org/wp-json/uaix/v1/adoption-kit
curl -s https://uaix.org/wp-json/uaix/v1/openapi.json
curl -s -X POST https://uaix.org/wp-json/uaix/v1/mock-exchange -H "Content-Type: application/json" -d @mock-exchange-request.json

先使用目录与发现路由,再拉取接入套件、检查 OpenAPI 文档,或直接请求一份实时 mock 响应。

本地化版本正在审查

此页面尚未作为经过审查的本地化标准提供。请使用权威英文来源查看规范性语言、模式解释、实现义务和支持边界。

打开权威英文来源