Coder Social home page Coder Social logo

yibinliao / document Goto Github PK

View Code? Open in Web Editor NEW

This project forked from leorian/document

0.0 0.0 0.0 8.76 MB

文档转换服务器（支持ppt/pptx/doc/docx/excel/excels文件转成pdf文件，封装的转换工具用windows office/wps/openoffice）

JavaScript 2.97% Java 85.61% CSS 11.39% HTML 0.03%

document's Introduction

文档转换中心接口调用说明文档

1、接口调用部分

        (1)、单文档异步转换请求

简要概述：目前该接口支持的源文件格式为(doc、docx、ppt、pptx、xls、xlsx),转换后的目标文件格式(pdf)
请求方式：HTTP POST
请求参数：
docFileUrl *：待转换文件在线链接地址（如上传七牛之后的返回的文档URL链接地址）
callBackUrl：异步转换成功之后的回调地址及通知地址（非必填项）
返回结果： 
  {
    "data": {
        "createTimeStamp": "1493858622500",
        "reAction": false,
        "taskContent": "http://okxyat5ou.bkt.clouddn.com/Java%E6%B3%9B%E5%9E%8B%E4%B8%8E%E5%8F%8D%E5%B0%84%E5%9C%A8%E5%BC%80%E5%8F%91%E4%B8%AD%E5%BA%94%E7%94%A8.pptx",
        "taskId": "93f9d616-5729-4889-b49c-27a9ff63ec52",
        "taskStatus": "WAITING"
    },
    "success": true
}

taskId:此次转换请求的任务执行情况跟踪的任务ID
taskContent:待转换文件在线链接地址，等同docFileUrl
taskStatus:任务状态（WATING：等待，EXECUTING:正在执行，SUCCESS:转换成功，FAILURE:转换失败）

        (2)、单文档同步转换请求

简要概述：目前该接口支持的源文件格式为(doc、docx、ppt、pptx、xls、xlsx),转换后的目标文件格式(pdf)
请求方式：HTTP POST
请求参数：
docFileUrl *：待转换文件在线链接地址（如上传七牛之后的返回的文档URL链接地址）
返回结果： 
{
    "data": {
        "createTimeStamp": "1493859562226",
        "executeTimeStamp": "1493859562228",
        "finishTimeStamp": "1493859585106",
        "reAction": false,
        "taskContent": "http://okxyat5ou.bkt.clouddn.com/Java%E6%B3%9B%E5%9E%8B%E4%B8%8E%E5%8F%8D%E5%B0%84%E5%9C%A8%E5%BC%80%E5%8F%91%E4%B8%AD%E5%BA%94%E7%94%A8.pptx",
        "taskContentExt": "pptx",
        "taskContentLength": "1.80MB",
        "taskId": "d28ce8f0-166d-4709-9b08-ea7a66de856e",
        "taskResult": "http://okxyat5ou.bkt.clouddn.com/FoyuZDhmtkxk91ikaoNBIXoyydno",
        "taskResultExt": "pdf",
        "taskResultLength": "1.84MB",
        "taskStatus": "SUCCESS"
    },
    "success": true
}

createTimeStamp:文档转换请求创建时间时间戳
executeTimeStamp:文档转换请求工作线程执行开始时间时间戳
finishTimeStamp:文档转换请求执行结束时间时间戳
reAction:任务执行超时时，是否重新执行过标识位（文档监控页面管理员使用）
taskContent:待转换文件在线链接地址，等同docFileUrl
taskContentExt:待转换文件文档格式（doc/docx/ppt/pptx/xls/xlsx）
taskContentLength:待转换文件文档大小
taskId:此次转换请求的任务执行情况跟踪的任务ID
taskResult:转换后目标文件在线链接地址
taskResultExt:转换后目标文件文档格式（pdf）
taskResultLength:转换后目标文件文档大小
taskStatus:任务状态（WATING：等待，EXECUTING:正在执行，SUCCESS:转换成功，FAILURE:转换失败）
errorCode:错误编码：如（E10001）
errorMessage:错误信息：如（Parameter Not Defined）

        (3)、多文档异步转换请求

简要概述：目前该接口支持的源文件格式为(doc、docx、ppt、pptx、xls、xlsx),转换后的目标文件格式(pdf)
请求方式：HTTP POST
请求参数：
docFileUrlList *：待转换文件在线链接地址,用英文逗号分隔（如上传七牛之后的返回的文档URL链接地址）
callBackUrl：异步转换成功之后的回调地址及通知地址（非必填项）
返回结果： 
{
    "data": [
        {
            "createTimeStamp": "1493860704943",
            "reAction": false,
            "taskContent": "http://okxyat5ou.bkt.clouddn.com/1.ppt",
            "taskId": "a1e5a65f-5b89-42fb-9ca8-8625774890df",
            "taskStatus": "WAITING"
        },
        {
            "createTimeStamp": "1493860704946",
            "reAction": false,
            "taskContent": "http://okxyat5ou.bkt.clouddn.com/2.docx",
            "taskId": "8cc27f76-f3cd-45b2-b3aa-497e572d5ebe",
            "taskStatus": "WAITING"
        },
        {
            "createTimeStamp": "1493860704951",
            "reAction": false,
            "taskContent": "http://okxyat5ou.bkt.clouddn.com/3.doc",
            "taskId": "d6fad0a6-14a1-40a1-b568-1eb2aa0db2e7",
            "taskStatus": "WAITING"
        },
        {
            "createTimeStamp": "1493860704956",
            "reAction": false,
            "taskContent": "http://okxyat5ou.bkt.clouddn.com/Java%E6%B3%9B%E5%9E%8B%E4%B8%8E%E5%8F%8D%E5%B0%84%E5%9C%A8%E5%BC%80%E5%8F%91%E4%B8%AD%E5%BA%94%E7%94%A8.pptx",
            "taskId": "29d5a4a7-c7e5-44ff-9450-bfacb0a8256a",
            "taskStatus": "WAITING"
        }
    ],
    "success": true
}

taskId:此次转换请求的任务执行情况跟踪的任务ID
taskContent:待转换文件在线链接地址，等同docFileUrl
taskStatus:任务状态（WATING：等待，EXECUTING:正在执行，SUCCESS:转换成功，FAILURE:转换失败）

        (4)、文档转换请求任务状态跟踪查询接口(返回结果跟callbackUrl回调结果一样)

简要概述：目前该接口支持的源文件格式为(doc、docx、ppt、pptx、xls、xlsx),转换后的目标文件格式(pdf)
请求方式：HTTP POST
请求参数：
taskId：任务ID
或者
docFileUrl：待转换文件在线链接地址（如上传七牛之后的返回的文档URL链接地址）
返回结果： 
{
    "data": {
        "createTimeStamp": "1493859562226",
        "executeTimeStamp": "1493859562228",
        "finishTimeStamp": "1493859585106",
        "reAction": false,
        "taskContent": "http://okxyat5ou.bkt.clouddn.com/Java%E6%B3%9B%E5%9E%8B%E4%B8%8E%E5%8F%8D%E5%B0%84%E5%9C%A8%E5%BC%80%E5%8F%91%E4%B8%AD%E5%BA%94%E7%94%A8.pptx",
        "taskContentExt": "pptx",
        "taskContentLength": "1.80MB",
        "taskId": "d28ce8f0-166d-4709-9b08-ea7a66de856e",
        "taskResult": "http://okxyat5ou.bkt.clouddn.com/FoyuZDhmtkxk91ikaoNBIXoyydno",
        "taskResultExt": "pdf",
        "taskResultLength": "1.84MB",
        "taskStatus": "SUCCESS"
    },
    "success": true
}

createTimeStamp:文档转换请求创建时间时间戳
executeTimeStamp:文档转换请求工作线程执行开始时间时间戳
finishTimeStamp:文档转换请求执行结束时间时间戳
reAction:任务执行超时时，是否重新执行过标识位（文档监控页面管理员使用）
taskContent:待转换文件在线链接地址，等同docFileUrl
taskContentExt:待转换文件文档格式（doc/docx/ppt/pptx/xls/xlsx）
taskContentLength:待转换文件文档大小
taskId:此次转换请求的任务执行情况跟踪的任务ID
taskResult:转换后目标文件在线链接地址
taskResultExt:转换后目标文件文档格式（pdf）
taskResultLength:转换后目标文件文档大小
taskStatus:任务状态（WATING：等待，EXECUTING:正在执行，SUCCESS:转换成功，FAILURE:转换失败）
errorCode:错误编码：如（E10001）
errorMessage:错误信息：如（Parameter Not Defined）

2、页面监控部分

(1)、图表展示异步文档转换请求执行情况（3s定时刷新一次）

![](http://i.imgur.com/hPDhj6c.png)

(2)、表格展示异步文档转换请求执行情况（3s定时刷新一次）

![](http://i.imgur.com/nLqv4FZ.png)

(3)、手动控制文档转换请求

WAITING:正在等待执行的任务队列，文档转换中心应用重启可以继续执行。
EXECUTING:正在执行中的任务队列，文档转换中心应用重启不可以继续执行，需要管理员手动重新执行。 ![](http://i.imgur.com/Mjlu15E.png)

3、文档转换请求模拟测试部分

异步文档转换请求模拟 ![](http://i.imgur.com/1IIP02o.png)

同步文档转换请求模拟 ![](http://i.imgur.com/02P2u95.png)

异步文档转换请求模拟（批量） ![](http://i.imgur.com/GS1lKyO.png)

4、错误码对应关系

    E10001("E10001", "Parameter Not Defined", "参数未定义！"),
    E10002("E10002", "Database Operation Error", "数据库操作异常！"),
    E10003("E10003", "WorkerThread Execute Error", "工作线程执行异常！"),
    E10004("E10004", "File Convert Error", "文件转换异常！"),
    E10005("E10005", "Not Find Relation Data", "未查询到相关数据！"),
    E10006("E10006", "File Unreachable", "文件链接地址不可达！"),
    E10007("E10007", "File Format UnSupport", "文件格式不支持！"),
    E10008("E10008", "File Size UnKnown", "文件大小未知"),
    E10009("E10009", "File Content Unreachable", "文件内容获取不到！"),
    E10010("E10010", "File Convert Error", "文件转换失败！"),
    E10011("E10011", "QiNiu Upload Error", "七牛上传失败"),
    E10012("E10012", "File Not Exist", "文件不存在！"),
    E10013("E10013", "Pdf Format Not Need Convert", "pdf格式文件无需转换！"),
    E10014("E10014", "Count Search Error", "统计查询异常！"),
    E10015("E10015", "QiNiu Get File Info Error", "七牛获取文件信息异常！"),
    E10016("E10016", "Net Work Error", "网络连接异常！"),
    E10017("E10017", "Open Office Service Error", "文件转换服务异常！"),
    E10018("E10018", "Login Failure Public Private Key Expire", "用户密码公钥私钥加密策略过期，请重新进入登录页面！"),;

document's People

Contributors

leorian avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.