docs(plugin): README 对齐——mock 的 SN 校验位算法已镜像真后端,补 source 字段说明
This commit is contained in:
+18
-3
@@ -77,15 +77,19 @@ node scripts/deploy.mjs --repo ../plugin-repo --no-build
|
||||
- 单格编辑面板里可手工填 SN,或「领 1 条」单独取码;
|
||||
- **校验选中格 SN** —— 格式 + 校验位 + 台账存在性,都由后端判定。
|
||||
|
||||
接口(与 `funjia.sn-tools` 插件共用同一套后端):
|
||||
接口(与 `funjia.sn-tools` 插件共用同一套后端,定义在
|
||||
`库存管理系统/backend/src/api/sn-code/`):
|
||||
|
||||
```
|
||||
GET /api/sn-codes/meta 业务类型 / 默认前缀 / 码长
|
||||
POST /api/sn-codes/generate 单条发放
|
||||
POST /api/sn-codes/batch 批量发放 → { items: [...] }
|
||||
POST /api/sn-codes/batch 批量发放 → { batch, count, items: [...] }
|
||||
POST /api/sn-codes/verify 校验 → { valid, reason, exists, record }
|
||||
```
|
||||
|
||||
发放时请求体里带 `source: "funjia.print-tag"` —— 后端把它记进 SN 台账,
|
||||
用来区分「这条码是插件发的还是别的入口发的」(不填一律记成 `pc`)。
|
||||
|
||||
两个命令也注册给了别的插件:
|
||||
|
||||
- `print-tag:issue-sn` —— 按业务类型领 N 条 SN;
|
||||
@@ -130,7 +134,18 @@ plugin/
|
||||
|
||||
`preview/mock-api.ts` 里**额外实现了 `/api/sn-codes/*`**(模板原本只有通用 CRUD)。
|
||||
少了它,本地一打开 SN 开关就是 404,只能走「构建 → 发布 → 装进宿主 → 点一遍」,
|
||||
一圈几分钟。注意:mock 的号段与校验位算法是本地自定的,**只验链路、别对号段**。
|
||||
一圈几分钟。
|
||||
|
||||
mock 的 SN 部分是**逐位镜像真后端**的(`库存管理系统/backend/src/api/sn-code/`):
|
||||
前缀表、SN 形状、格式正则、序号补位口径,以及**校验位算法与字符表**都照抄 ——
|
||||
所以预览里生成的 SN 拿去真后端 `/verify` 也能过校验位,本地调通的链路切到真后端不会失效。
|
||||
唯一不是真的地方是**数据**:台账在进程内存里,重启即清空。**只验链路,别对号段。**
|
||||
|
||||
调真后端:
|
||||
|
||||
```bash
|
||||
PREVIEW_API_TARGET=http://127.0.0.1:1337 npm run dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user