eoLinker 新功能釋出，增加了識別程式碼註釋自動生成文件功能

吳億歐發表於2017-11-22

產品地址：www.eolinker.com
開原始碼：www.eolinker.com/#/os/downlo…
線上生成程式碼註釋工具：tool.eolinker.com/doc2code
註釋生成文件指令碼：github.com/eolinker/Co…

eoLinker提供了從程式碼註釋直接生成介面文件的功能，有效地將介面文件與程式碼實現了同步。本篇文章將詳細介紹如何通過eoLinker的Python指令碼程式來生成文件。

【必要條件】
eoLinker使用者帳戶
已經線上上版建立了一個專案
已經獲取專案的Project_Key以及Secret_Key
eoLinker註釋生成文件指令碼：github.com/eolinker/Co…

【如何獲取Project_Key以及Secret_Key？】
在專案概況頁面，點選其他功能-自動生成文件按鈕，會出現以下彈框，顯示相關的Project_Key以及Secret_Key。

eioasddzidongshengcheng.jpg
eioasddzidongshengcheng.jpg

【環境要求】
目前程式碼註釋生成文件支援Python，需要安裝2.7以上版本的Python，並且開啟re、codes、requests模組。

【相關工具】
eoLinker自動生成文件指令碼：github.com/eolinker/Co…
eoLinker線上生成程式碼註釋工具：tool.eolinker.com/doc2code

【規範】
eoLinker擁有自己的文字標記語言（EOML），為了減少輸入流程，請使用eoLinker提供的線上生成程式碼註釋工具(http://tool.eolinker.com/doc2code)。
group，[必填]，API分組名稱
childGroup，[選填]，子分組名稱（歸屬於group之下）
status，[必填]，介面狀態，work（啟用）| maintain（維護）| abandoned（棄用）
protocol，[必填]，請求協議，http|https
method，[必填]，請求方式，post | get | put | delete | head | options | patch
path，[必填]，API地址
name，[必填]，API名稱
header，[選填]，請求頭部，內容使用{}包裹
name，頭部名稱
value，頭部引數值
parameter，[選填]，請求引數，內容使用{}包裹
name，引數名
type，引數型別，string | file | json | int | float | double | date | datetime | boolean | byte | short | long | array | object
required，是否必填，true（是）|false（否）
response，[選填]，返回引數，內容使用{}包裹
name，引數名
description，描述
type，引數型別，string | file | json | int | float | double | date | datetime | boolean | byte | short | long | array | object
required，是否一定返回，true（是）|false（否）

【例子一（使用/ /註解）】
/

  • group = "父分組";
  • childGroup = "子分組";
  • status = "work";
  • protocol = "http";
  • method = "POST";
  • path = "www.baidu.com";
  • name = "測試";
  • header = {name="Accept-Charset",value="utf-8"};
  • header = {name="Content-Type",value="application/xml"};
  • parameter = {name = "userID", type = "string", description = "使用者ID", required = true};
  • parameter = {name = "userName", type = "string", description = "使用者名稱稱", required = true};
  • response = {name = "statusCode",description = "狀態碼", type = "string", required = true};
    */

【例子二（使用’’’或”””註解）】
”””
group = "父分組";
childGroup = "子分組"
status = "work";
protocol = "http";
method = "POST";
path = "www.baidu.com6";
name = "測試";
header = {name="Accept-Charset",value="utf-8"};
header = {name="Content-Type",value="application/xml"};
parameter = {name = "userID", type = "string", description = "使用者ID", required = true};
parameter = {name = "userName", type = "string", description = "使用者名稱稱", required = true};
response = {name = "statusCode",description = "狀態碼", type = "string", required = true};
”””

【配置檔案】
project_key，專案key
secret_key，密碼key
file_path，讀取檔案的目錄路徑,window系統請按照r"c:\test"或者"c:\test"寫法寫
file_suffix，讀取檔案的字尾名，比如php或py或java
exclude_file，排除檔名
user_name，eoLinker使用者賬號
user_password，使用者密碼

【配置檔案例子】
project_key = 'uwiuryomx3asudhcami3y498cy7m2'
secret_key = '7962h4s83asd'
file_path = 'C:\project\code_upload'
file_suffix = 'java'
exclude_file = ['gitignore','config.php']
user_name = 'test'
user_password = '123456'

完成以上配置之後，執行eolinker.py指令碼既可自動生成文件，返回“成功”則自動生成成功，否則失敗。

eoLinker是一個免費開源的針對開發人員需求而設計的介面管理工具，通過簡單的操作來幫助開發者進行介面文件管理、介面自動化測試、團隊協作、資料獲取、安全防禦監控等功能，降低企業的介面管理成本，提高專案的整體開發效率，支援自動化測試管理、許可權管理、程式碼生成、團隊協作，並且提供PC端產品以及瀏覽器增強外掛，讓介面管理更加簡單。

相關文章