OpenAPI 规范

API 的完整机器可读地图 - 所有端点、请求、响应和错误。

OpenAPI 是用机器可读文件描述 HTTP API 的行业标准格式。

https://api.wontopos.com/openapi.json

用它能做什么

Postman: File → Import → 粘贴 URL,所有端点变成可点击的集合。ChatGPT: 创建 GPT,添加 Action,粘贴同一 URL。代码生成: openapi-generator -i .../openapi.json -g go 生成我们未提供语言的客户端。

导入 Postman、为我们未提供的语言生成客户端、接入 ChatGPT Actions、或在 CI 里做契约校验。测试将它钉在真实路由上,不会漂移。

llms.txt

把整个 API 装进 AI 能读的一页文本。

llms.txt 是一种网络惯例:放在站点根目录的一页纯文本,把 AI 需要了解的产品信息全部讲清。

https://wontopos.com/llms.txt

放进 IDE 或编码智能体,它就知道怎么在 WOS 上构建 - 认证、端点、模式、错误。每次发布同步更新。

与 OpenAPI 规范同样的事实,不同的读者:规范是给工具的精确结构,这个文件是 AI(或人)一口气读完的散文。两者都随每次发布更新。