3.1 KiB
3.1 KiB
name, description, metadata
| name | description | metadata | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| session-20260619-1 | 2026-06-19 第1次会话 — 接入文档全面审查和修复:permission字段补充、字段说明表、v-permission指令、Widget修复、废弃放行API、删除登录API |
|
2026-06-19 第1次会话
会话摘要
用户指出的接入文档(docs/integration-guide.md 和 IntegrationDoc.vue)中 INSERT SQL 缺少 permission 字段、字段含义未解释等问题,要求以"接入方开发者"视角全面审查文档,确保人家(非AI)能看懂并照着接入。进行了大范围审查和修复。
关键操作
1. 初始化SQL补充 permission 字段 + 按钮权限示例
- 做了什么:两个文件的菜单初始化 INSERT SQL 加上
permission列,目录=NULL、菜单=页面权限标识、新增按钮(menu_type=3)示例(新增/编辑/删除) - 原因:接入系统需要知道怎么创建按钮权限
- 结果:SQL 完整覆盖目录→菜单→按钮三级结构,含注释说明
2. 新增字段说明表
- 做了什么:第六章新增 6.1 节,含 sys_menu / sys_role / sys_role_menu 三张表的字段说明表格 + permission 命名规范示例表
- 原因:用户指出"字段意思没解释,人家一脸懵"
- 结果:每个字段的类型、必填、不同 menu_type 下填什么都写清楚了
3. 新增 v-permission 指令章节
- 做了什么:Markdown 3.6 / Vue 3.7 新增按钮权限控制章节,含 directive 代码、全局注册、模板用法
- 原因:接入方不知道怎么用 permissions 控制前端按钮显隐
- 结果:完整可复制的代码示例
4. Widget 接入章节大修
- 做了什么:从简单三行 HTML 改为正确的 polyfill 三步接入(process polyfill + mount后动态加载),加了排查清单
- 原因:原方式在浏览器会报
process is not defined,且说"如果不想手写代码"语气不对——这是必须这样做的步骤 - 结果:与 Vue 组件中 3.6 节一致,接入方不会踩坑
5. 废弃放行 API 章节
- 做了什么:新增 sys_api 章节后又根据用户指示完全移除(该功能已废弃)
- 原因:用户说"放行 API 配置废弃了,可以去掉"
6. 删除登录 API 章节
- 做了什么:删除 Markdown 5.1 / Vue 5.1 登录接口章节(请求体/响应体/字段说明全移除),API 章节重新编号
- 原因:用户指出"登录是网关的登录页面,业务系统没有登录页",所以不应该文档里出现登录API
7. 其他修复
- 3.2 环境变量加说明表(各变量从哪获取)
- 3.5 多系统场景改为跳转URL带 systemCode 参数(不再调用登录API)
- 5.0 新增错误码表(200/401/403/500)
- 管理员BCrypt改为 Python/Java/在线工具三种具体方式
- 普通用户角色说明(为何初始化不给菜单、怎么手动分配)
- 测试清单移除"未放行API"项
修改文件
docs/integration-guide.mdmokee-gateway-web/src/views/docs/IntegrationDoc.vue
待处理
- 部署前端到服务器使线上文档页生效