1.URL

http://124.223.60.234:18080/tms/help/searchDocs

2.请求参数

2.1请求头

在Headers里面增加token:对应登录验证成功后，data里面对应的tokenId

2.2.参数示例

{
    "key":"Login"
}

2.3 请求参数

参数 类型 必填 说明
key string 是 模糊搜索key

3.接口应答

3.1.返回示例

{
    "code": 200,
    "message": "Operation succeeded",
    "data": [
        {
            "id": 17,
            "title": "Login",
            "categoryId": 3,
            "categoryName": "User Manual",
            "updatedAt": "2026-03-23T22:41:34",
            "previewUrl": "https://cloud.ucargo.ai:2443/doc/view/17"
        },
        {
            "id": 7,
            "title": "Login Authentication",
            "categoryId": 5,
            "categoryName": "API Doc",
            "updatedAt": "2026-03-23T16:51:34",
            "previewUrl": "https://cloud.ucargo.ai:2443/doc/view/7"
        },
        {
            "id": 8,
            "title": "Obtain all organizational information manageable",
            "categoryId": 5,
            "categoryName": "API Doc",
            "updatedAt": "2026-03-23T16:51:36",
            "previewUrl": "https://cloud.ucargo.ai:2443/doc/view/8"
        },
        {
            "id": 9,
            "title": "Query all sub-organizations under a specific organization",
            "categoryId": 5,
            "categoryName": "API Doc",
            "updatedAt": "2026-03-24T13:42:11",
            "previewUrl": "https://cloud.ucargo.ai:2443/doc/view/9"
        },
        {
            "id": 16,
            "title": "Environmental monitoring terminal G series solution-cold chain drug transportation",
            "categoryId": 2,
            "categoryName": "Product Introduction",
            "updatedAt": "2026-03-23T18:24:34",
            "previewUrl": "https://cloud.ucargo.ai:2443/doc/view/16"
        }
    ]
}

3.2.返回结果说明

字段 类型 说明
code int 返回状态
message String 返回结果描述
data object 返回结果体

data说明

字段 类型 说明
id Integer 文档 ID
title String 文档标题
categoryId Integer 分类 ID
categoryName String 分类名称
updatedAt String 更新时间
previewUrl String 预览链接（已拼接 preview-url 前缀）
Author：admin  Create time：2026-03-24 14:12
Last editor：admin  Update time：2026-04-15 21:25