Codex cowork-server API 设计:统一分页、筛选和 OpenAPI
EnglishCodex 安装步骤
- 打开固定版本的 GitHub 原文。在该版本的工作副本中保留 `.agents/skills/api-design/` 整个目录。
- 在目标项目中打开 Codex,输入 `$api-design` 并给出本页示例里的任务和所需输出。
中文摘要
按 cowork-server 约定设计资源路径、列表查询参数、响应封装和 OpenAPI 注解,适合新增普通数据列表端点。
SKILL.md 中文导读
可复现示例
在本地练习项目输入 `$api-design`,为图书列表拟一个支持状态筛选和分页的端点,要求列出请求样例与响应字段。工作步骤
- 检查已有资源命名和列表参数绑定,选定路径、筛选与分页方式。
- 为成功与错误结果选择仓库的响应写法,补充 OpenAPI 说明和验收请求。
验收方法
得到明确的集合路径、页码与条数参数、响应结构和 OpenAPI 摘要,调用方可据此写本地测试。
GitHub 原文 · 更新日期
适用环境
Codex 与 cowork-server 工作副本。准备现有 Kotlin 控制器、响应封装和可核对的 API 样例。
常见问题
普通成功响应如何封装?
上游约定采用 CommonApiResponse 的 data 字段,错误沿项目既有全局处理器表达。