Skip to content

v0.7.0 — 可读性优化(点路径 Schema / 请求体示例 / 鉴权 dedup)

Choose a tag to compare

@leeguooooo leeguooooo released this 08 Jun 07:02
· 33 commits to main since this release

可读性修复(endpoint 模式 XML 输出)

1. 响应 Schema 字段名 → 完整点路径

widdershins 的 »/»»/»»» 嵌套标记 geeky 难读,改为重建完整点路径:
data → data.activities[] → data.activities[].activityId → data.pagination.hasMore。
数组对象父级加 [],子字段读作 parent[].child。无歧义、可复制进代码、全 ASCII。

2. 移除「调用流程」mermaid 图

固定骨架,只是重述 鉴权/参数/响应/分页 已有信息 → 删除。

3. 鉴权 dedup

单一鉴权方案时 drop 独立「鉴权」段(顶部 callout 的 🔑 行已覆盖);多方案(OR)才保留段(callout 一行装不下列表)。

4. 轻量分隔

各主区块(参数 / 响应 / 响应 Schema / 示例 / 调用前检查)间加 <hr/>。

5. 请求体渲染(POST/PUT/PATCH)

  • 移除 widdershins 的原始 > Body parameter JSON-Schema dump(冗余噪音)。
  • 新增 pretty-print 请求体示例 (JSON) <pre lang=json caption=请求体示例>,从 requestBody schema 合成(example/default/enum/format/类型默认值),置于 curl 请求示例之前。GET/DELETE 跳过。

保留

顶部 📌 callout、pre caption、约束列、curl 请求示例、调用前检查 checkbox。无颜色、无 button(Lark 导入会剥离)。

注:本版含 v0.6 的「缓存纳入版本号」修复,普通 sync 会自动重推全部接口。

消费方:npx github:leeguooooo/openapi-lark 拉 main。