文档转换API格式

Base URL

http://{ip}:{port}/docconverter

路由

🔒 = 需要鉴权

预览流程

前端调用 获取当前文件是否可以直接预览或者下载 接口，根据返回的信息

1. 如果返回可以预览，调用对当前文件进行pdf预览接口进行预览。
2. 如果返回不可以预览，在转换中，则需要定时调用获取当前文件是否可以直接预览或者下载。
3. 如果返回不可以预览且文档没有在转换请输出返回的错误信息。

文档预览

• 🔒 文件是否可以直接预览或者下载 : GET /doc/minio/able_to_preview/:code
• 🔒 文件进行pdf预览 : POST /doc/minio/pdf/preview/:code

文档转码

• 🔒 文件进行转码 : GET /doc/pdf/transform/:code
• 🔒 文件是否已转换好 : GET /doc/pdf/transformed/:code

文件是否可以直接预览或者下载

Method : GET

URL : {{baseUrl}}/doc/able_to_preview/:code

URL Parameters : code=[string] code 文档的编码

Auth required : True

Request Params

返回示例

{
    "success": true,
    "msg": null,
    "code": 0,
    "data": {
        "canView": "Y",
        "isConverting": "N",
        "errorMsg": null
    }
}

返回参数

说明：

1. 如果可以预览，调用预览接口进行预览。
2. 如果不可以预览，在转换中，则需要定时调用此接口获取文档的转换信息。
3. 如果不可以预览且文档没有在转换请输出错误信息。

文件进行pdf预览

Method : POST

URL : {{baseUrl}}/doc/pdf/preview/:code

URL Parameters : code=[string] code 文档的编码

Auth required : True

Body :

{
  "enableWater": "Y",
  "contents": [
    {
      "type": "TEXT",
      "content": "xxxxxx",
      "divImgWidth": null,
      "divImgHeight": null
    },
    {
      "type": "IMAGE",
      "content": "https://xxxx.png",
      "divImgWidth": 10,
      "divImgHeight": 80
    }
  ],
  "fontSize": 12,
  "opacity": 0.4,
  "color": {
    "r": 0,
    "g": 0,
    "b": 0
  },
  "density": "SINGLE",
  "rotation": "HORIZONTAL"
}

请求参数

返回示例
文件流

对文件进行转码

Method : POST

URL : {{baseUrl}}/doc/transform/:code

URL Parameters : code=[string] code 文档的编码

Auth required : True

Body :

请求参数

Request Params

返回示例

{
    "code": 200,
    "msg": "",
    "data": null
}

文件是否已转换好

Method : POST

URL : {{baseUrl}}/doc/transformed/:code

URL Parameters : code=[string] code 文档的编码

Auth required : True

Body :

请求参数

Request Params

返回示例

{
    "code": 200,
    "msg": "",
    "data": null
}

返回示例

{
    "success": true,
    "msg": null,
    "code": 0,
    "data": {
        "canView": "Y",
        "isConverting": "N",
        "errorMsg": null,
        "targetCode": ""
    }
}

返回参数