快速登陸機器&數據庫

本文來自網易雲社區。

做者：盛國存

背景

咱們平常在使用ApiDoc維護管理api文檔，提升了api文檔的總體維護性。但在老舊接口中，補充接口註解無疑是一次繁重的體力勞動。仔細查看，大多數接口的格式 實際上是類似的，那麼，是否能夠將體力活作的技術一些?

答案是sure，只須要三步。分析log，構建接口數據，生成APIDoc。

過程闡述

下面以我的開發機器下的某個測試接口爲例，闡述整個過程：

在實際的業務中可能存在這樣的日誌（前提是全部的業務日誌都是經過同一套標準進行輸出的）

重點看紅框標註的部分。依次爲，日誌等級、logId、uri、arrRequest/action tpl data。仔細分析，咱們會發現，TRACE模式即爲請求，包含全部請求信息。DEBUG模式即爲響應，包含全部響應信息。具體數據結構不作贅述。

以此爲例，根據日誌模式、logId、uri、arrRequest、tpl data 等信息能夠構建標準的接口請求&返回信息。 

須要注意的是:

    一、單個日誌中可能會存在日誌的多個請求，因此要對分析後的日誌作數據過濾; 

    二、若是接口返回數據中存在list，要對list作單一化處理(不然後續的生成的apidoc會存在大量重複字段); 

    三、日誌讀取儘可能使用yield(要不大文件會扛不住的);

處理邏輯就不描述了，so easy。

那麼添加一個新的apidoc的步驟如今變爲:

    a、從log.dt解析接口的請求&返回數據;

    b、提取uri、method、requestparam、retData等字段; 

    c、根據接口uri每一個接口只留取一個請求實例; 

    d、遍歷接口返回數據的結構，list數組中只留取一個item實例; 

    e、根據apidoc的格式拼裝數據，按照uri生成獨立文件; 

    f、剪貼至action，並完成字段註釋等操做;

其中a-e的操做 能夠概述爲 打開瀏覽器器(1s)→刷業務頁面(10s)→執行腳本(1s)→複製粘貼(1s)→補充字段註釋信息(xxxs)

只須要一個簡單的命令

ApiDoc就寫好了

再執行一下 apidoc -i xxxx -o xxxx 就大功告成了

總結

現實開發的過程當中，存在着不少重複瑣碎的事情，好比維護繁瑣的文檔，每更新一次代碼都須要執行一次apidoc命令，有時候會常常忘記，咱們能夠搞一個crontab檢測文件夾是否有過改動，有的話就自動執行一次命令，一年能夠省下很多時間哩……^_^，平常還有不少相似的事，能夠開發一些小工具將偷懶發揮到極致。

網易雲免費體驗館，0成本體驗20+款雲產品！

更多網易研發、產品、運營經驗分享請訪問網易雲社區。

相關文章：
【推薦】 數據遷移的應用場景與解決方案Hamal
【推薦】 數據分析中，用戶行爲分析最重要的3個點
【推薦】 聊聊WS-Federation