Skip to content

表单接口

表单接口用于管理表单的创建、查询和操作。

查询表单列表

请求

bash
GET /api/v1/forms

参数

参数类型说明
pageint页码
sizeint每页数量
namestring表单名称(模糊匹配)

响应

json
{
  "success": true,
  "data": {
    "content": [
      {
        "id": "form001",
        "name": "请假申请表",
        "code": "leave-form",
        "status": "published",
        "createTime": "2024-01-15T10:00:00Z"
      }
    ],
    "totalElements": 1,
    "totalPages": 1
  }
}

获取表单详情

请求

bash
GET /api/v1/forms/{formId}

响应

json
{
  "success": true,
  "data": {
    "id": "form001",
    "name": "请假申请表",
    "code": "leave-form",
    "description": "员工请假申请",
    "layout": "grid",
    "columns": 2,
    "fields": [
      {
        "type": "text",
        "fieldName": "applicant",
        "label": "申请人",
        "required": true
      }
    ],
    "status": "published"
  }
}

创建表单

请求

bash
POST /api/v1/forms
Content-Type: application/json

参数

json
{
  "name": "请假申请表",
  "code": "leave-form",
  "description": "员工请假申请",
  "layout": "grid",
  "columns": 2,
  "fields": [
    {
      "type": "text",
      "fieldName": "applicant",
      "label": "申请人",
      "required": true
    },
    {
      "type": "select",
      "fieldName": "leaveType",
      "label": "请假类型",
      "options": [
        {"value": "personal", "label": "事假"},
        {"value": "sick", "label": "病假"}
      ]
    }
  ]
}

响应

json
{
  "success": true,
  "data": {
    "id": "form001",
    "name": "请假申请表"
  }
}

更新表单

请求

bash
PUT /api/v1/forms/{formId}
Content-Type: application/json

参数

json
{
  "name": "请假申请表(新版)",
  "description": "更新描述"
}

删除表单

请求

bash
DELETE /api/v1/forms/{formId}

发布表单

请求

bash
PUT /api/v1/forms/{formId}/publish

预览表单

请求

bash
GET /api/v1/forms/{formId}/preview

表单字段操作

添加字段

bash
POST /api/v1/forms/{formId}/fields
Content-Type: application/json

{
  "type": "text",
  "fieldName": "newField",
  "label": "新字段"
}

更新字段

bash
PUT /api/v1/forms/{formId}/fields/{fieldName}
Content-Type: application/json

{
  "label": "更新后的标签"
}

删除字段

bash
DELETE /api/v1/forms/{formId}/fields/{fieldName}