視頻通話會議系統EasyRTC使用apiDoc生成pdf文件操作流程介紹

一般在我們正式的EasyRTC開發過程中，是以pdf或者word的紙質版本作爲開發歸檔文檔，html文檔不能作爲歸檔文檔，所以需要生成pdf文檔；有時也會遇到用戶需要正式文檔情況，這兩種情況我們就要將文檔生成PDF文檔。

apiDoc爲一款針對RestfulAPI的文檔自動生成工具。在Restful軟件架構中，後端人員編寫軟件開發接口，生成接口文檔給前端。apiDoc最終生成的文檔爲html文件。

後端軟件開發接口示例如下：

/**
 * @api {POST} /v1/conference/add 01. 添加視頻會議
 * @apiGroup 02conference
 *
 * @apiParam {String} name 會議名稱
 * @apiParam {String} taskID 會議任務號
 * @apiParamExample {json} Request-Example
   {
      "name": "測試視頻會議",
      "taskID": "task100"
   }
 *
 * @apiSuccess {String} id 會議房間號
 * @apiSuccess {String} name 會議名稱
 * @apiSuccess {Bool} online 會議狀態
 * @apiSuccess {String} numbers 會議在線人數
 * @apiSuccess {String} taskID 會議任務號
 * @apiSuccess {String} updateAt 最後更新時間
 * @apiSuccessExample  {json} Response-Example
   {
      "code": 200,
      "msg":
      {
         "id": 1331,
         "name": "測試視頻會議",
         "online": false,
         "numbers": "0",
         "taskID": "task100",
         "updateAt": "2020-01-22 00:11:44"
      }
   }
*/

然後運行一下命令即可生成html文件。

apidoc -i routes -o apidoc

上述命令中-i代表輸入文件夾，-o代表輸出文件夾，命令總體操作爲掃描routes文件夾下的所有文件，然後在apidoc目錄下生成html文件。如下所示：

打開index.html文檔如下：

以上文檔對於閱讀非常方便，但是在軟件開發流程中，經常有需要生成正式文檔的需求，比如word或者pdf文檔格式進行保存。

html文檔生成pdf文檔具體步驟

1. 安裝apidoc-markdown、

npm install  apidoc-markdown -g

2. 安裝typora

安裝完以上工具後即可進行開始製作：

• 運行一下命令將apidoc生成的html文檔轉換成markdown文件。

apidoc-markdown -p apidoc -o doc_markdown.md

以上命令爲掃描apidoc文件夾下的所有文件然後生成doc_markdown.md文檔。

• 使用typora打開doc_markdown.md，在文件中選擇導出pdf文檔即可。

但是直接導出的pdf文檔可能有問題，因爲導出的markdown文件中會存在html標籤，導致生成的文檔出現很多

等html標籤，非常影響閱讀。所以需要對markdown文件進行改造，刪除下圖示例中的所有html標籤。

刪除所有標籤後，然後再使用typora生成pdf文檔即可。最終生成的文檔部分截圖如下：

本文中使用typora生成了pdf文檔。讀者也可以使用pandoc等實用工具進行文檔的轉換。