eoLinker-AMS開(kāi)源版 部署指南

eoLinekr-AMS接口管理系統(tǒng)開(kāi)源版本

注意：3.x版本與2.x版本并不兼容，因此無(wú)法直接由2.x升級(jí)到3.x，也無(wú)法通過(guò)覆蓋代碼的方式進(jìn)行升級(jí)，切勿隨意嘗試以防數(shù)據(jù)丟失

如果需要進(jìn)行數(shù)據(jù)的遷移，可以使用eoLinker接口管理系統(tǒng)中的【導(dǎo)出項(xiàng)目】功能
將項(xiàng)目導(dǎo)出為eoLinker專用格式（.export），然后在3.x版本中導(dǎo)入。
同時(shí)為了防止數(shù)據(jù)丟失，請(qǐng)?jiān)趫?zhí)行任何關(guān)鍵操作之前妥善備份數(shù)據(jù)庫(kù)

一、環(huán)境要求

• PHP 5.5+ / PHP7+（推薦）
• Mysql 5.5+ / Mariadb 5.5+
• Nginx（推薦） / Apache
• 項(xiàng)目目錄需要具有完全的讀寫權(quán)限（777），用于寫入配置文件。安裝完成之后可以設(shè)置另外設(shè)置目錄權(quán)限
• PHP需要安裝并啟用mbstring以及curl模塊，用于字符串處理以及接口測(cè)試功能

二、注意事項(xiàng)

• 3.x版本與2.x版本并不兼容，因此無(wú)法直接由2.x升級(jí)到3.x，也無(wú)法通過(guò)覆蓋代碼的方式進(jìn)行升級(jí)，切勿隨意嘗試以防數(shù)據(jù)丟失；
• 如果需要進(jìn)行數(shù)據(jù)的遷移，可以使用eoLinker接口管理系統(tǒng)中的【導(dǎo)出項(xiàng)目】功能：將項(xiàng)目導(dǎo)出為eoLinker專用格式（.export），然后在3.x版本中導(dǎo)入；
• 為了防止數(shù)據(jù)丟失，請(qǐng)?jiān)趫?zhí)行任何關(guān)鍵操作之前妥善備份數(shù)據(jù)庫(kù)；

三、安裝指南

從Github等途徑獲取開(kāi)源版代碼之后，目錄結(jié)構(gòu)如下：

其中：

• backend_resource：后端源碼
• frontend_resource：前端源碼（未壓縮，使用Angular進(jìn)行編寫）
• release：安裝包，可用于直接安裝

打開(kāi)release文件夾，找到最新版本的壓縮包，解壓到合適的PHP環(huán)境下，并且通過(guò)瀏覽器訪問(wèn)項(xiàng)目根目錄。如果正常則會(huì)轉(zhuǎn)到如下引導(dǎo)頁(yè)面：

根據(jù)指引頁(yè)面提示，輸入相應(yīng)信息并且通過(guò)環(huán)境監(jiān)測(cè)后，即可安裝成功。隨后頁(yè)面會(huì)跳轉(zhuǎn)至用戶注冊(cè)頁(yè)面。

開(kāi)源版的使用操作與線上免費(fèi)版基本同步，如有任何使用的問(wèn)題請(qǐng)參考 線上版操作指南。

------------------------------------------------------------------------------------------

eoLinker API Management System（AMS）是一款幫助企業(yè)開(kāi)發(fā)人員進(jìn)行在線管理接口文檔、進(jìn)行自動(dòng)化測(cè)試、團(tuán)隊(duì)協(xié)作的工具，它旨在提高企業(yè)項(xiàng)目的接口管理水平，提升開(kāi)發(fā)速度并且降低運(yùn)維成本。

eoLinker是目前業(yè)內(nèi)領(lǐng)先、國(guó)內(nèi)最大的在線API接口管理平臺(tái)，提供自動(dòng)生成API文檔、API自動(dòng)化測(cè)試、Mock測(cè)試、團(tuán)隊(duì)協(xié)作等功能，旨在解決由于前后端分離導(dǎo)致的開(kāi)發(fā)效率低下問(wèn)題。現(xiàn)已為Google、IBM、騰訊、中國(guó)聯(lián)通、中國(guó)移動(dòng)、華為、中外運(yùn)、海爾、拉卡拉、神州優(yōu)車、國(guó)美等近千家企業(yè)提供快速、專業(yè)、穩(wěn)定的API管理服務(wù)。

eoLinker還是Google谷歌開(kāi)發(fā)者聯(lián)盟的戰(zhàn)略合作企業(yè)，不定期舉辦線下交流分享活動(dòng)促進(jìn)國(guó)內(nèi)API管理領(lǐng)域的發(fā)展；支持及擁抱開(kāi)源，不斷地開(kāi)放各種強(qiáng)大的功能與全球開(kāi)發(fā)者共享！

1、免費(fèi)&開(kāi)源：eoLinker擁有強(qiáng)大的免費(fèi)產(chǎn)品，在過(guò)去的一年里面eoLinker已迭代超過(guò)300個(gè)版本，優(yōu)化近千功能點(diǎn)，同時(shí)秉承開(kāi)源精神，提供國(guó)際化的開(kāi)源產(chǎn)品（支持中文簡(jiǎn)體、繁體以及英語(yǔ)），為廣大的開(kāi)發(fā)、測(cè)試以及管理人員提供全面、易用、專業(yè)的產(chǎn)品。

2、同類產(chǎn)品中最強(qiáng)大的API文檔管理系統(tǒng)：支持目前HTTP/HTTPS協(xié)議以及所有主流請(qǐng)求方式，并且提供了強(qiáng)大的版本管理功能，可以隨時(shí)隨地回滾API信息；同時(shí)支持?jǐn)?shù)據(jù)庫(kù)管理、狀態(tài)碼管理、項(xiàng)目文檔管理等常用管理功能。

3、代碼自動(dòng)生成文檔：通過(guò)讀取代碼中的EOML（eoLinker標(biāo)注語(yǔ)言）注解，eoLinker可以自動(dòng)生成API文檔，省去了重復(fù)錄入的麻煩，無(wú)縫連接開(kāi)發(fā)與管理工作。

4、API接口測(cè)試：支持文件、在線、跨域、自動(dòng)化測(cè)試等功能。同時(shí)擁有參數(shù)構(gòu)造器，可以對(duì)請(qǐng)求參數(shù)進(jìn)行自動(dòng)構(gòu)造，加密、分割、隨機(jī)字符串等功能一應(yīng)俱全。配合測(cè)試用例可以非常方便地對(duì)比請(qǐng)求結(jié)果與模型，找出API可能出現(xiàn)的問(wèn)題。

5、API自動(dòng)化測(cè)試：eoLinker是目前全球唯一一款支持界面與代碼雙模式的自動(dòng)化測(cè)試工具。在UI界面模式下，你不需要編寫任何代碼即可創(chuàng)建數(shù)據(jù)相互關(guān)聯(lián)的API測(cè)試用例（比如注冊(cè)-登錄-檢查登陸狀況-退出登錄）；同時(shí)你也可以通過(guò)編寫Javascript代碼來(lái)構(gòu)造復(fù)雜的自動(dòng)化測(cè)試場(chǎng)景。這些都極大地簡(jiǎn)化了開(kāi)發(fā)測(cè)試人員的API測(cè)試工作，每次開(kāi)發(fā)完成只需要一個(gè)鍵即可自動(dòng)測(cè)試所有API并且生成測(cè)試報(bào)告，幫助了解項(xiàng)目API的健康狀況。

6、API Mock測(cè)試：提供最強(qiáng)的Mock功能，支持MockJS，支持自動(dòng)刷新返回結(jié)果以及多種返回的結(jié)果。同時(shí)還支持對(duì)API進(jìn)行請(qǐng)求校驗(yàn)，當(dāng)參數(shù)或值不符合預(yù)設(shè)的模板時(shí)能夠及時(shí)找出問(wèn)題所在。

7、支持文檔分享和導(dǎo)出：你可以通過(guò)eoLinker在線生成接口文檔，也可以導(dǎo)出成為HTML、PDF以及Word等，快速分享或發(fā)布API信息。

8、支持Postman、RAP、RestClint等數(shù)據(jù)導(dǎo)入：無(wú)需重新錄入API信息，一鍵導(dǎo)入即可切換平臺(tái)。

9、強(qiáng)大的團(tuán)隊(duì)協(xié)作功能：你可以通過(guò)URL快速邀請(qǐng)成員或者加入某個(gè)項(xiàng)目，eoLinker提供了全面的日志追蹤以及權(quán)限管理功能。

10、擁有最全面的產(chǎn)品線：eoLinker除了擁有線上版本之外，還提供了免費(fèi)開(kāi)源版本、瀏覽器插件、PC端桌面程序等，可以滿足企業(yè)所有的API管理需求。