Files
aibridge/docs
2026-05-18 09:28:15 +08:00
..
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00
2026-05-18 09:28:15 +08:00

AIBridge - JNPF 低代码平台 Python 接口包

通过 AI 对话快速完成产品设计、应用开发和验证。

功能特性

  • API 全覆盖:封装 JNPF 平台 9 大模块 200+ 端点
  • 配置构建器:从简洁字段描述自动生成完整 JSON 配置
  • 端到端开发:登录 → 创建功能 → 发布 → 创建菜单 → 数据操作
  • DI 代理 SQL:通过 DataInterface 间接执行 SQL
  • 双 HTTP 客户端:主接口 + 报表独立接口

架构

JNPFClient (认证/HTTP)
├── AuthAPI           认证(登录/登出/用户信息)
├── MenuAPI           菜单管理(CRUD/目录/表单菜单)
├── UserAPI           用户管理(CRUD/岗位/导入导出)
├── OrganizeAPI       组织管理(公司/部门)
├── RoleAPI           角色管理
├── PositionAPI       岗位管理
├── DictionaryAPI     数据字典(分类+数据)
├── VisualDevAPI      ★可视化开发核心(功能/发布/OnlineDev/代码生成)
├── OnlineDevAPI      OnlineDev 数据操作便捷接口
├── WorkflowAPI       工作流(任务/审批/模板/委托/监控/Webhook)
├── DataInterfaceAPI  数据接口(CRUD/预览/字段/日志)
├── InterfaceOauthAPI 接口认证(外部系统访问控制)
├── PortalAPI         门户管理
├── MessageAPI        消息公告(公告/消息中心/IM)
├── DataSourceAPI     数据源(连接/测试/同步)
├── PrintDevAPI       打印模板(CRUD/版本)
├── ReportAPI         Univer 报表
├── SysConfigAPI      系统配置
├── FileAPI           文件管理(上传/下载/知识库)
└── Builders          配置构建器(字段/表单/列表/表结构/完整配置/移动端字段)

快速上手

from aibridge import JNPFClient, JNPFConfig
from aibridge.builders import build_full_config, build_create_payload

# 1. 创建客户端并登录(App-Code 自动设置 systemId)
client = JNPFClient.from_config(JNPFConfig())
client.login()  # 自动使用配置中的账号密码

# 2. 构建表单配置
config = build_full_config(
    full_name="文具销售商管理",
    en_code="salesVendorManage",
    table_name="base_sales_vendor",
    table_label="文具销售商表",
    description="文具销售商管理系统",
    category="e43a773b8a024d109dfb176e99f08a35",
    fields=[
        {"field": "f_full_name", "fieldName": "销售商名称", "required": True},
        {"field": "f_en_code", "fieldName": "销售商编码", "required": True},
        {"field": "f_contact", "fieldName": "联系人"},
        {"field": "f_phone", "fieldName": "联系电话"},
    ],
)

# 3. 创建功能
payload = build_create_payload(config)
resp = client.visual_dev.create(payload)
func_id = resp.id

# 4. 发布(systemId 继承自创建步骤)
client.visual_dev.release(func_id)

# 5. 创建菜单(App-Code 自动设置 systemId)
menu_resp = client.menu.create_form_menu(
    full_name="文具销售商管理",
    en_code="salesVendorManage",
    visual_dev_id=func_id,
    parent_id="parent_dir_menu_id",
)

模块访问

# 所有 API 模块通过 client 属性访问
client.auth.login(...)        # 或 client.login(...)
client.menu.get_list(...)
client.visual_dev.create(...)
client.workflow.audit(...)

# 或单独实例化
from aibridge.modules import VisualDevAPI
api = VisualDevAPI(client)

响应处理

resp = client.menu.get_list()
if resp.success:
    print(resp.data)          # 直接获取 data
    print(resp.id)            # 快捷获取 id
else:
    print(resp.code, resp.msg)  # 错误码和消息

# 要求成功,否则抛异常
client.require_success(resp)

目录结构

aibridge/
├── __init__.py          # 包入口
├── client.py            # JNPFClient 核心客户端
├── models.py            # 数据模型
├── exceptions.py        # 异常体系
├── config.py            # 配置管理
├── modules/             # 16 个 API 模块
├── builders/            # 6 个配置构建器(字段/表单/列表/表结构/完整配置/移动端字段)
├── utils/               # 工具模块
├── tests/               # 测试
├── examples/            # ★ 标准示例
│   └── quickstart.py    # 完整操作示例(登录/表单/菜单/DI/工作流/软删除)
└── docs/                # 文档
    ├── portal/         # 门户开发指南(21种组件+27个API)
    ├── workflow/       # 工作流开发指南(示例+指南+故障排查)
    ├── control/        # 控件开发指南
    ├── datainterface/  # 数据接口开发指南
    └── codedev/       # ★ 扩展开发指南(前后端代码模式)
        ├── README.md          # 速查索引
        ├── 01-backend-pattern.md   # 后端开发模式
        ├── 02-frontend-pattern.md  # 前端开发模式
        ├── 03-examples-index.md   # 示例目录
        ├── 04-import-export.md     # 导入导出详解
        ├── 05-table-operation.md   # 表格操作
        ├── 06-chart-examples.md   # 图表示例
        ├── 07-form-examples.md     # 表单控件
        ├── 08-special-features.md  # 特殊功能
        └── 09-quick-start.md      # 快速开发模板

测试

移动端 H5 测试

项目位置:uniapp/(基于 jnpf/移动端/jnpf-app-vue3 复制)

运行步骤:

  1. 用 HBuilderX 导入项目(菜单:文件 → 导入 → 从本地项目导入)
  2. 菜单:运行 → 运行到浏览器 → Chrome

命令行运行(项目需先用 HBuilderX 导入):

/Applications/HBuilderX.app/Contents/MacOS/cli launch web --project $ccWorkDir/uniapp

Playwright 移动端测试:

cd $ccWorkDir/test
npx playwright test mobile --reporter=line

PC 端测试

cd $ccWorkDir/test
npx playwright test --reporter=line