接口简介
「OpenAPI 文档骨架生成」是数据鱼API平台提供的接口文档骨架生成工具接口,Base 路径 /api/api-spec-builder,共 4 个端点,输入接口标题、路径与方法三个要素,输出一份符合 OpenAPI 3.0.0 规范的最小可用文档骨架。它面向接口先行(design-first)的工作流:新接口立项时先拿到一份结构合法、可被主流工具链直接解析的 spec 底稿,再由开发者在底稿上补齐参数、请求体、错误码与示例,避免每次都手写样板结构。
生成逻辑完全确定:spec 由 openapi 版本号(3.0.0)、info(title 取输入值、version 固定 1.0.0)与 paths 三部分组成;paths 按传入路径建立条目,方法键取输入方法的小写形式,其下固定挂一个 200 响应描述。除三个输入外没有任何隐藏逻辑,同一输入永远得到同一份 spec,便于在流水线里做确定性模板。
接口不做参数强校验:三个参数均可省略(省略时采用默认标题 API、默认路径 /api/resource、默认方法 GET),传入什么就按什么生成。方法字符串会被转大写后作为规范方法名输出,但服务端不验证其是否为标准 HTTP 方法,输入合法性由调用方保证。生成结果以 JSON 返回,可直接落盘为 .yaml/.json 文件或提交进文档仓库。
接口共 4 个端点:免鉴权的健康检查、版本统计,以及同一引擎的 GET 与 POST 两个 run 入口。
端点总览
方法 路径 说明 鉴权
GET /api/api-spec-builder/ping 健康检查(免鉴权) 免鉴权
GET /api/api-spec-builder/stats 返回服务版本号 需要
POST /api/api-spec-builder/run 生成 OpenAPI 骨架(主入口) 需要
GET /api/api-spec-builder/run 生成 OpenAPI 骨架(主入口,query 传参) 需要
通用约定
鉴权使用 X-API-Key 请求头或 ?api_key= 查询参数,全站统一 Key:缺失返回 4011,无效返回 4013。响应为统一三段结构 {code, msg, data},code 为 0 表示成功。三个生成参数均可选,常规调用不触发参数错误;参数类错误 4001~4004 的语义与其他接口一致,4040 为路由不存在,4050 为方法不允许。POST 支持 JSON body 或表单,参数名与 query 完全一致,两种传参方式可按客户端习惯选择。以上为数据鱼API平台全站通用约定。
核心端点详解
骨架生成(GET/POST /run)
用途:按标题、路径、方法生成一份 OpenAPI 3.0.0 最小骨架。
参数 类型 必填 默认 说明
title string 否 API 接口标题,写入 info.title
path string 否 /api/resource 接口路径,作为 paths 的键
method string 否 GET HTTP 方法,输出时转为小写方法键
返回字段要点:spec 为生成的 OpenAPI 文档对象——openapi 固定为 3.0.0;info.version 固定为 1.0.0,info.title 取输入标题;paths 仅含传入路径一个条目,方法键下固定挂 200 响应(description 为 Success)。响应整体为 {spec: ...} 结构。
请求示例:
POST /api/api-spec-builder/run
Content-Type: application/json
{"title": "订单查询", "path": "/api/order/query", "method": "GET"}
query 传参的等价形式:
GET /api/api-spec-builder/run?api_key=YOUR_KEY&title=订单查询&path=/api/order/query&method=GET
服务统计(GET /stats)
无请求参数,返回版本号(当前 1.0),用于部署确认与变更感知。
GET /api/api-spec-builder/stats?api_key=YOUR_KEY
健康检查(GET /ping)
免鉴权,无请求参数,返回服务器时间,用于探活。
GET /api/api-spec-builder/ping
数据与限制
生成的 spec 为最小骨架:仅含版本、info 与单个路径条目,不包含 parameters、requestBody、components、servers 等结构,需由调用方按规范补齐。
method 会经大写规范化后转小写作为方法键,但不做标准方法白名单校验;title 与 path 原样写入,不做路径合法性检查。
版本字段固定:spec 的 openapi 为 3.0.0,info.version 为 1.0.0,均不接受输入覆盖。
计算无状态、无缓存、无外部依赖;生成结果不会在服务端保存,调用方需自行持久化。
典型使用场景
接口立项自动化:在创建新服务或新端点的脚手架里调用 run,一键产出可提交的文档底稿。
CI 流水线前置检查:按仓库中的路由清单批量生成骨架,与已有 spec 做差集提醒补文档。
文档工具链输入:把骨架直接喂给文档渲染、Mock 服务或 SDK 生成工具作为初始定义。
注意事项
服务端不校验 method 取值,传入任意字符串都会进入方法键(如 method=abc 会生成 "abc" 操作),产出不合法的 OpenAPI 文档;调用方应把输入限定为 GET/POST/PUT/DELETE 等标准方法。
path 传入带空格、大写或尾斜杠的值会原样保留,与实际路由不一致时会导致工具链按错误的路径解析,建议传入前做路径规范化。
生成的 200 响应仅为占位描述,正式交付前必须补齐响应结构与错误码,避免把骨架直接当作完整文档发布。
免省略陷阱:完全不传参也能得到默认骨架(标题 API、路径 /api/resource、方法 GET),流水线中若漏传参数不易察觉,建议生成后对 info.title 与 paths 键做断言。
本接口属于数据鱼API平台开发工具类接口,鉴权与错误码处理方式与其他接口一致。