dsh-apis-plugin 0.2.1 → 0.2.3
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/README.md +5 -1
- package/api-tools.js +19 -16
- package/client.js +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,7 +30,7 @@ config/
|
|
|
30
30
|
└── api_doc.md
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
> cfg 文件名任意(`api.cfg`、`config.cfg`、`<host>.cfg`
|
|
33
|
+
> cfg 文件名任意(`api.cfg`、`config.cfg`、`<host>.cfg` 均可),扫描**递归**收集目录下所有 `*.cfg`(含任意深度子文件夹,限 5 层),集合身份只看里面的 `host` 字段;同一个子文件夹放多个 cfg 即为多个集合。**新增/修改 cfg 后需点「扫描」或重启生效。**
|
|
34
34
|
|
|
35
35
|
### 1. xxx.cfg(每个集合一份,必需)
|
|
36
36
|
|
|
@@ -40,6 +40,9 @@ key=value 行格式,`#` 注释,UTF-8 编码:
|
|
|
40
40
|
# 集合标识(如网站域名),用于展示与「集合名/路径」消歧
|
|
41
41
|
host=site-a.example.com
|
|
42
42
|
|
|
43
|
+
# 集合用途说明(可选),会展示在接口目录与手风琴中,方便 AI 理解查询范围
|
|
44
|
+
title=xxx
|
|
45
|
+
|
|
43
46
|
# 该集合的接口服务前缀:域名 + nginx 前缀 + 网关路由段
|
|
44
47
|
baseUrl=http://your-host/api
|
|
45
48
|
|
|
@@ -50,6 +53,7 @@ apis=
|
|
|
50
53
|
```
|
|
51
54
|
|
|
52
55
|
- `host`:集合名,缺失时依次回退 baseUrl 的主机名、文件所在文件夹名
|
|
56
|
+
- `title`:集合用途说明(可选),AI 查目录与 UI 手风琴均会展示
|
|
53
57
|
- `baseUrl`:请求时拼接在该集合的接口路径前(改文件即生效,无需重启)
|
|
54
58
|
- `apis`:该集合的接口白名单,支持 `{param}` 模板段(如 `/users/{id}`),agent 请求时填实际值
|
|
55
59
|
- **增删接口只改这个文件**,改完点插件配置页的「扫描」(或重启)生效
|
package/api-tools.js
CHANGED
|
@@ -26,10 +26,9 @@ function loadCfgFile(file) {
|
|
|
26
26
|
return cfg
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
//
|
|
29
|
+
// 扫描目录下的「接口集合」:递归遍历目录下所有 *.cfg(含根目录直放与任意深度子文件夹),
|
|
30
30
|
// 集合名取 cfg 的 host 字段(缺失时依次回退 baseUrl 的主机名、文件所在文件夹名)
|
|
31
31
|
function scanCollections(dir) {
|
|
32
|
-
if (!dir) return []
|
|
33
32
|
const out = []
|
|
34
33
|
const hostFromUrl = (url) => {
|
|
35
34
|
try {
|
|
@@ -40,18 +39,22 @@ function scanCollections(dir) {
|
|
|
40
39
|
}
|
|
41
40
|
const push = (file) => {
|
|
42
41
|
const cfg = loadCfgFile(file)
|
|
43
|
-
if (cfg.apis.length) out.push({ name: cfg.host || hostFromUrl(cfg.baseUrl) || basename(dirname(file)), file, dir: dirname(file), baseUrl: cfg.baseUrl || '', apis: cfg.apis })
|
|
42
|
+
if (cfg.apis.length) out.push({ name: cfg.host || hostFromUrl(cfg.baseUrl) || basename(dirname(file)), title: cfg.title || '', file, dir: dirname(file), baseUrl: cfg.baseUrl || '', apis: cfg.apis })
|
|
44
43
|
}
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
44
|
+
// 递归下钻,限深 5 层防符号链接成环
|
|
45
|
+
const walk = (d, depth) => {
|
|
46
|
+
if (depth > 5) return
|
|
47
|
+
let entries
|
|
48
|
+
try {
|
|
49
|
+
entries = readdirSync(d, { withFileTypes: true })
|
|
50
|
+
} catch { /* 目录不可读时跳过 */ }
|
|
51
|
+
for (const entry of entries ?? []) {
|
|
52
|
+
const p = join(d, entry.name)
|
|
53
|
+
if (entry.isDirectory()) walk(p, depth + 1)
|
|
54
|
+
else if (entry.isFile() && entry.name.endsWith('.cfg')) push(p)
|
|
53
55
|
}
|
|
54
|
-
}
|
|
56
|
+
}
|
|
57
|
+
if (dir) walk(dir, 0)
|
|
55
58
|
return out
|
|
56
59
|
}
|
|
57
60
|
|
|
@@ -132,7 +135,7 @@ export function defineApiPlugin(options) {
|
|
|
132
135
|
// 部署侧静态接口(yml config.endpoints + 工厂默认),与 cfg 动态读取分离,避免重扫时把旧列表拼回去
|
|
133
136
|
const staticEndpoints = [...new Set([...defaultEndpoints, ...(config.endpoints ?? [])])]
|
|
134
137
|
// 集合持久化为 JSON(客户端只读展示;文档分节不落盘)
|
|
135
|
-
const plain = (cs) => JSON.stringify(cs.map(({ name, baseUrl, apis }) => ({ name, baseUrl, apis })))
|
|
138
|
+
const plain = (cs) => JSON.stringify(cs.map(({ name, title, baseUrl, apis }) => ({ name, title, baseUrl, apis })))
|
|
136
139
|
const mergedEndpoints = (cs) => [...new Set([...cs.flatMap((c) => c.apis), ...staticEndpoints])]
|
|
137
140
|
|
|
138
141
|
const bootCollections = loadCollections(ymlApiDir)
|
|
@@ -168,10 +171,10 @@ export function defineApiPlugin(options) {
|
|
|
168
171
|
`${ns}: settings watch`,
|
|
169
172
|
)
|
|
170
173
|
|
|
171
|
-
//
|
|
174
|
+
// 已配置接口目录(按集合分组展示,title 说明集合用途;部署侧静态接口不在任何集合时单独一组)
|
|
172
175
|
function catalogText() {
|
|
173
176
|
const groups = collections.map((c) =>
|
|
174
|
-
`【${c.name}】${c.baseUrl ? `(baseUrl: ${c.baseUrl})` : ''}\n` + c.apis.map((e) => ' ' + e).join('\n'))
|
|
177
|
+
`【${c.name}】${c.title ? `(${c.title})` : ''}${c.baseUrl ? `(baseUrl: ${c.baseUrl})` : ''}\n` + c.apis.map((e) => ' ' + e).join('\n'))
|
|
175
178
|
const dyn = new Set(collections.flatMap((c) => c.apis))
|
|
176
179
|
const extra = staticEndpoints.filter((e) => !dyn.has(e))
|
|
177
180
|
if (extra.length) groups.push('【部署侧固定接口】\n' + extra.map((e) => ' ' + e).join('\n'))
|
|
@@ -210,7 +213,7 @@ export function defineApiPlugin(options) {
|
|
|
210
213
|
// 工具 1:查接口文档,让模型了解每个接口的参数与响应(prompt 按领域名拼接)
|
|
211
214
|
ctx.tools.register({
|
|
212
215
|
name: `${prefix}_api_doc`,
|
|
213
|
-
description: `查询${domainName}接口文档。接口按集合组织(集合名取各 cfg 文件的 host
|
|
216
|
+
description: `查询${domainName}接口文档。接口按集合组织(集合名取各 cfg 文件的 host 字段,cfg 的 title 字段标注该集合用途),api_doc.md 与部署的服务一一对应,是这些接口的权威依据。传 path(如 /users/page,跨集合同名接口用「集合名/路径」如 site-a.com/users/page)返回该接口的详细参数与响应说明;不传 path 返回通用说明和全部集合的接口目录。发起请求前先用它确认参数,按文档直接调用即可,不要再去查阅后端源码或其他材料核实接口行为。`,
|
|
214
217
|
parameters: {
|
|
215
218
|
path: { type: 'string', description: '接口路径,如 /users/{id};跨集合同名时用 集合名/路径' },
|
|
216
219
|
},
|
package/client.js
CHANGED
|
@@ -114,7 +114,10 @@ window.__ModuleLoader__.load({
|
|
|
114
114
|
onClick: () => setOpenGroups((m) => ({ ...m, [g.name]: !m[g.name] })),
|
|
115
115
|
children: [
|
|
116
116
|
jsx(Chevron, { open: isOpen }),
|
|
117
|
-
|
|
117
|
+
jsxs("div", { className: "apis-headText", children: [
|
|
118
|
+
jsx("span", { className: "apis-groupName", title: g.name, children: g.name }),
|
|
119
|
+
g.title && jsx("span", { className: "apis-desc", children: g.title }),
|
|
120
|
+
] }),
|
|
118
121
|
jsx("span", { className: "apis-count", children: `${apis.length} 个接口` }),
|
|
119
122
|
],
|
|
120
123
|
}),
|