結論先說
- 別讓 Codex 一口氣掃描幾十個控制器直接吐出幾千行 YAML,必須拆成「路由盤點 → 分組生成 → 自動 Lint 校驗」三段式。先輸出精簡路由清單確認沒有漏掉前綴、全局鑑權中間件和統一響應包裝器,再按業務模組生成
openapi.yaml,準確度能大幅提高。 - 明確鎖定 OpenAPI
3.1.0語法,並用npx @redocly/cli lint做零報錯硬門禁。AI 經常把 OpenAPI 3.0 的nullable: true混進 3.1 文檔(3.1 全面兼容 JSON Schema 2020-12,應寫type: ["string", "null"]),也容易拼錯$ref路徑;每次生成完必須讓 Codex 自己跑通 Redocly 校驗直到零錯誤。 - 堅持「源碼實證」原則:禁止模型腦補任何未在代碼裏出現的字段與錯誤碼。在提示詞和
AGENTS.md中要求 Codex 必須結合校驗器(Zod / Pydantic / Go Struct Tag / Jakarta Validation)和全局異常處理類推導 Schema,源碼模糊處用x-needs-review: true顯式標記待人工核對。 - 交付給 Postman 與 Apifox 時,以校驗通過的
openapi.yaml為唯一真相源。Postman 與 Apifox 均支持直接導入標準 OpenAPI 3.1 文檔並自動建目錄與模型;若測試團隊需要自帶變量和狀態斷言的現成冒煙集合,再讓 Codex 配套導出 Postman Collection v2.1 與僅含佔位符的環境變量 JSON(嚴禁寫入真實生產 Token)。 - 全倉庫反向梳理幾十條接口、跨控制器追蹤多層 DTO 與錯誤枚舉非常消耗長上下文與推理配額。國內若缺少外幣卡或原套餐窗口經常觸頂,可在本站按需開通 ChatGPT Plus 充值 或高配額 ChatGPT Pro 充值,團隊多人聯調可了解 ChatGPT Business 團隊定製。

圖:本站根據 OpenAPI 3.1 規範 與 Redocly 文檔 整理的示意圖
本文根據 OpenAPI 官方規範《OpenAPI Specification v3.1.0》、Redocly 官方文檔《redocly lint》、Postman 官方文檔《Importing from OpenAPI》及 OpenAI Codex 官方文檔《Codex CLI》整理,資料核對於 2026-11-19。配圖為本站整理的示意圖,不是介面截圖。本站(bigolab.com)不是 OpenAI 官方網站。
適用於誰
- 接手歷史 Express、Go Gin、Spring Boot 或 PHP 老項目,面臨接口零文檔、前後端聯調全靠口頭問和翻源碼的工程師;
- 試過直接讓 AI 寫 Swagger / OpenAPI YAML,結果拿到一堆損壞的
$ref引用、混用 3.0 與 3.1 語法、或者憑空編造請求字段的開發者; - 希望一鍵產出通過嚴格校驗的
openapi.yaml,並順暢導入 Postman 或 Apifox 給前端、測試團隊直接發請求聯調的研發團隊。
一、第一步先盤點接口清單,再在 AGENTS.md 鎖死契約規範
在生成正式 YAML 前,先把以下文檔生成規範寫入倉庫 AGENTS.md(若為大型多服務倉庫可配合子目錄分層配置,見 /guides/codex-large-monorepo-layered-agents-md-scoped-test-guide):
markdown
# OpenAPI 3.1 接口文檔生成約束(AGENTS.md)
## 規範與溯源紅線
- 文檔版本嚴格鎖定 `openapi: 3.1.0`;可空字段使用 JSON Schema 2020-12 語法(`type: ["string", "null"]`),禁止混用 3.0 廢棄的 `nullable: true`。
- 每個字段的類型、必填項(`required`)、枚舉值與 4xx/5xx 錯誤響應必須能在倉庫路由、校驗器或全局異常處理器中找到源碼依據;無法確認時顯式添加 `x-needs-review: true` 並附源碼位置註釋,禁止憑空編造。
- 所有可複用數據結構與錯誤信封統一抽到 `components.schemas`,全局鑑權抽到 `components.securitySchemes`。
## 交付與校驗門禁
- 生成或更新 `docs/openapi.yaml` 後,必須執行 `npx @redocly/cli lint docs/openapi.yaml` 直至 0 errors。
- 配套導出的 `docs/postman_environment.json` 僅允許填寫 `{{baseUrl}}`、`REPLACE_WITH_DEV_TOKEN` 等佔位符,嚴禁寫入任何真實密鑰或線上域名憑據。
二、實戰兩段式提示詞:從源碼提取到 Redocly 零錯通過
階段 1:掃描並輸出接口盤點表(Plan Mode / 只讀審查)
text
請先只讀掃描 src/routes/、src/controllers/、src/middlewares/auth* 與全局錯誤處理中間件,先不要生成 YAML,輸出一份 `docs/endpoint-inventory.md` 盤點表:
1. 列出路由前綴掛載關係、全局統一響應信封格式(如 code/data/message)與鑑權頭名稱;
2. 按業務標籤分組列出每條接口的 Method、完整 Path、鑑權要求、請求校驗文件位置與響應結構文件位置;
3. 單獨標註出缺少顯式類型定義或動態返回 JSON 的遺留接口,等我確認範圍後再進入 OpenAPI 3.1 生成。
階段 2:按模組生成 docs/openapi.yaml 並跑通 Lint 校驗
text
請基於剛才確認的 `docs/endpoint-inventory.md`,對照真實源碼生成 `docs/openapi.yaml`(OpenAPI 3.1.0):
1. 為每個接口補齊唯一的 `operationId`、簡明中文 `summary`、標籤分組 `tags`、路徑/查詢/請求體參數、真實可用的 `examples` 以及 200/400/401/403/404/422 響應結構;
2. 所有公共 DTO、分頁結構與統一錯誤體全部抽入 `components.schemas` 用 `$ref` 複用;
3. 寫完後運行 `npx @redocly/cli lint docs/openapi.yaml`,逐條修掉所有 Schema 語法錯誤、斷鏈 `$ref` 和重名 `operationId`,直到零 Error 輸出;
4. 同步生成一份可導入 Postman 與 Apifox 的 `docs/postman_collection.json`(Collection v2.1,含基礎狀態碼測試腳本)和脫敏版 `docs/postman_environment.json`。
訂閱與帳號準備提示:反向梳理數十個老接口並反覆跑 Redocly 規範校驗、同步導出測試集合,屬於典型的多文件重上下文任務(額度與省額方法見 /guides/codex-save-usage-quota-model-reasoning-context-tips)。重度接口治理與全棧聯調推薦按需選用 ChatGPT Pro 5x iOS 可覆蓋檔 或 ChatGPT Pro 5x 信用卡不可覆蓋檔;新帳號註冊遇到手機驗證環節可查看 Codex 註冊手機驗證服務。
三、導入 Postman 與 Apifox 的最佳協作姿勢
拿到校驗通過的文檔後,按團隊協作需要決定直接導入 OpenAPI 還是導入派生集合:

圖:本站根據 Postman 導入文檔 與團隊聯調經驗整理的示意圖
具體操作非常輕量:在 Postman 中點擊左上角 Import 選擇 docs/openapi.yaml 即可自動生成帶目錄與示例值的 Collection;在 Apifox 中進入項目「項目設定 → 導入數據 → OpenAPI / Swagger」選擇該文件並開啟按接口路徑增量覆蓋即可。隨後還可以把這份 openapi.yaml 作為前後端類型生成的唯一契約(詳見 /guides/codex-fullstack-api-openapi-contract-type-alignment-guide),並把 npx @redocly/cli lint 放進 CI 防止文檔再次腐爛。
常見問題
問:項目接口超過 100 個,一次性生成 openapi.yaml 上下文裝不下怎麼辦?
答:千萬不要把上百個接口硬塞進一輪對話。本站建議採用多文件拆分結構:先建根文件 docs/openapi.yaml(放 info、servers、securitySchemes 與公共 schemas),再按業務域拆出 docs/paths/orders.yaml、docs/paths/users.yaml 等子文件逐批讓 Codex 生成,最後用 npx @redocly/cli bundle docs/openapi.yaml -o docs/openapi.bundled.yaml 合併成單文件導入 Postman 或 Apifox。
問:反向生成的文檔怎麼防止過兩個月業務代碼改了、文檔又過期?
答:最省心的做法是在倉庫 AGENTS.md 裏追加一條規則:凡是修改了路由路徑、請求校驗器或響應 DTO,Codex 在同一筆改動裏必須同步更新對應 docs/openapi.yaml 片段並跑通 Redocly 校驗;如果原本框架(如 FastAPI、Springdoc)本身支持代碼註解導出 OpenAPI,也可以用 Codex 反向補齊缺失註解,讓文檔徹底由構建流水線自動產出。
問:用 Codex 治理大項目接口文檔、做全棧聯調很耗額度,個人或團隊怎麼開通高配額訂閱、能否開增值稅發票?
答:可前往本站 AI 會員充值總覽 按需選購 ChatGPT Plus 充值、ChatGPT Plus 自助卡密 或更高額度的 ChatGPT Pro 充值,團隊多人聯調採購可了解 ChatGPT Business 團隊定製。支持支付寶、微信支付和 AlipayHK,自助卡密無需提供帳號密碼,並支持開具增值稅發票;實時價格與規格以頁面展示為準,售後執行掉訂閱按剩餘天數折退、封號不在質保範圍規則。
相關教學
- 用 Codex 做全棧接口聯調與前後端類型對齊:先生成 OpenAPI 契約再改代碼
- Codex 接手大型 Monorepo 項目怎麼配:子目錄分層 AGENTS.md 與局部測試技巧
- Codex 寫代碼時愛刪測試或亂改無關文件怎麼辦:5 條 AGENTS.md 硬約束護欄
- Codex 額度消耗太快怎麼省:模型檔位切換、推理強度降級與控上下文 6 招
參考資料
- OpenAPI Initiative:OpenAPI Specification v3.1.0 — https://spec.openapis.org/oas/v3.1.0
- Redocly 官方文檔:redocly lint command — https://redocly.com/docs/cli/commands/lint
- Postman 官方文檔:Import an OpenAPI definition — https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-from-openapi/
- OpenAI Codex 官方文檔:Codex CLI — https://learn.chatgpt.com/docs/codex/cli
0 條評論
還沒有評論,來搶沙發~