@fxri/swagger2api 1.2.14 → 1.2.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,37 @@
1
- # @fxri/swagger2api
1
+ # Swagger 转 API
2
+
3
+ ## 1.2.16
4
+
5
+ > 2026-11-13 发布
6
+
7
+ ### ⚡ 优化改进
8
+
9
+ - 文档站导航与侧栏抽为 `docs/site-nav.json` 单一数据源,站点配置只做引用展开
10
+ - 导航与产物校验改由工具命令执行,删除三份本地校验脚本
11
+
12
+ ## 1.2.15
13
+
14
+ > 2026-11-06 发布
15
+
16
+ ### ✨ 新增功能
17
+
18
+ - 文档站 404 兜底页与导航规范校验
19
+
20
+ ### 🔧 功能调整
21
+
22
+ - 配置选项从 CLI 参考拆为独立「配置参考」页,导航不再依赖锚点
23
+ - 页面标题「新手指南」「FAQ」统一为「快速开始」「常见问题」,全站链接文案同步
24
+
25
+ ### ⚡ 优化改进
26
+
27
+ - 文档站校验补 404 两条断言(`search: false`、`sitemap.transformItems`),并在构建后核验产物
28
+ - 404 页加 `search: false`,不进入站内搜索索引
29
+ - 文档站顶栏收敛为 4 项、侧栏重排为 4 组,常见问题与更新日志统一进「帮助」
30
+ - 404 页从站点地图过滤,避免被搜索引擎当正常页面收录
31
+
32
+ ### 🐛 问题修复
33
+
34
+ - 产物断言改为从 `404.md` 读取一级标题比对搜索索引,避免改标题后检查静默失效
2
35
 
3
36
  ## 1.2.14
4
37
 
package/README.md CHANGED
@@ -38,17 +38,17 @@ export const request = new Api()
38
38
  request.getUsers().then((res) => console.log(res))
39
39
  ```
40
40
 
41
- 完整步骤见 [新手指南](./docs/getting-started.md)。
41
+ 完整步骤见 [快速开始](./docs/getting-started.md)。
42
42
 
43
43
  ## ✨ 能力矩阵
44
44
 
45
45
  | 能力 | 适用场景 | 文档 |
46
46
  | --- | --- | --- |
47
- | 快速生成 | 从 Swagger JSON 生成 TS/JS 接口文件,含请求方法与类型定义 | [新手指南](./docs/getting-started.md) |
47
+ | 快速生成 | 从 Swagger JSON 生成 TS/JS 接口文件,含请求方法与类型定义 | [快速开始](./docs/getting-started.md) |
48
48
  | 多文档配置 | 自动扫描 `./**/saconfig*.json`,多项目接口配置集中管理 | [完整攻略](./docs/guide.md#多文档配置) |
49
49
  | 快速模式 | 配置齐全时跳过二次确认,搭配脚本一行命令静默更新 | [完整攻略](./docs/guide.md#快速模式) |
50
50
  | 唯一 operationId | 接口地址 + 请求方法拼接唯一 ID,可选 get 转 query 作区分 | [完整攻略](./docs/guide.md#唯一-operationid-拼接规则) |
51
- | 灵活裁剪 | 移除路径参数 / 前缀索引、替换标签、移除空组件定义 | [CLI 参考](./docs/cli.md#配置选项) |
51
+ | 灵活裁剪 | 移除路径参数 / 前缀索引、替换标签、移除空组件定义 | [配置参考](./docs/config.md) |
52
52
  | 响应提取 | AxiosResponse 转移到 raw 字段,根部字段自行声明 | [完整攻略](./docs/guide.md#提取响应--extract-response-raw-err) |
53
53
  | STA 参数透传 | swagger-typescript-api 原生参数全量可用 | [CLI 参考](./docs/cli.md) |
54
54
 
@@ -56,10 +56,10 @@ request.getUsers().then((res) => console.log(res))
56
56
 
57
57
  | 文档 | 适合谁 |
58
58
  | --- | --- |
59
- | [新手指南](./docs/getting-started.md) | 第一次接触,想 30 秒跑起来 |
59
+ | [快速开始](./docs/getting-started.md) | 第一次接触,想 30 秒跑起来 |
60
60
  | [完整攻略](./docs/guide.md) | 日常使用:三种模式、响应提取、配置文件 |
61
61
  | [CLI 参考](./docs/cli.md) | 查命令、参数、默认值 |
62
- | [FAQ](./docs/faq.md) | 遇到问题先来这里找 |
62
+ | [常见问题](./docs/faq.md) | 遇到问题先来这里找 |
63
63
  | [完整文档站](https://fxri-net.github.io/swagger2api/) | 在线阅读体验 |
64
64
 
65
65
  ## 📦 安装
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fxri/swagger2api",
3
- "version": "1.2.14",
3
+ "version": "1.2.16",
4
4
  "description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
5
5
  "license": "MIT",
6
6
  "author": {