RAP, 高效前後端聯調架構，接口文檔管理工具

RAP通過GUI工具幫助WEB工程師更高效的管理接口文檔，同時通過分析接口結構自動生成Mock資料、校驗真實接口的正确性，使接口文檔成為開發流程中的強依賴。有了結構化的API資料，RAP可以做的更多，而我們可以避免更多重複勞動。

• 建構項目 (war包部署不需要)
  • 擷取源代碼
  • 導入到IDE
• 配置環境
  • 安裝基本工具
  • 初始化資料庫
  • 配置檔案
  • 配置context-root （war包部署不需要）
• 啟動項目
• 常見問題
  • 如何管理團隊
  • 如何增加管理者
  • 如何擷取更新？
  • Admin初始密碼是什麼？

寫在最前

部署RAP需要親具有J2EE+Linux+MySQL的運維知識，如果親對此不是很了解，建議用http://rap.taobao.org線上版本就可以了。

自己部署RAP服務的同學，為了在有新Release、發現重大安全漏洞時能夠及時的通知到各位管理者，請訂閱重要資訊推送帖

部署方式有兩種。

1. 使用編譯好的war包部署
   • 适合僅想部署RAP服務，不需開發定制功能的同學
2. 使用源碼自行編譯、開發後部署
   • 需配置J2EE開發環境， 适合想要研究RAP源代碼，開發定制功能的同學

war包部署方法

在Release頁面中下載下傳war包（建議用最新）， 将war包修改為

ROOT.war

後放入tomcat webapps檔案夾中。 startup.sh(.bat)啟動tomcat，該war包自動部署到檔案夾ROOT 停掉伺服器，打開ROOT中得WEB-INF

/classes/config.properties

 來修改資料庫配置 啟動tomcat，完成部署。

注意，一定要用ROOT部署，曆史原因暫時隻支援ROOT部署
           

建構項目 (war包部署不需要)

擷取源代碼

git clone [email protected]:thx/RAP.git
git checkout release      

確定您正确的切換到release分支，否則會出現少包，因為master分支引用一些不對外公開的内部元件，不提供給外部使用者使用。

導入到IDE

以MyEclipse為例，在Package Explorer中右鍵 -> Import -> Existing Projects into Workspace, 将RAP項目導入進來。

根據您IDE的不同，導入項目的方式也有所差異。建議自行檢索，如果您根本不懂Java開發，建議跳過這裡用編譯好的war包部署吧。 d- .-b|||

配置環境

安裝基本工具

• 僅使用源碼自行編譯才需要安裝的(即，使用war包部署不需要安裝)
  • Eclipse/MyEclipse/IDEA
  • Git
• 都需要安裝的
  • JDK 1.8+ 

    若報錯，請盡量使用較新版本

  • MySQL 5.6.12+ 

    太老的MySQL運作initialize.sql會報多timestamp錯誤

  • Tomcat 8.*+ 

    不要用9alpha，alpha和beta出任何詭異問題我肯定不知道，親願意折騰倒也無妨，個人不建議

  • Redis 3.0+ 

    部署在本機，預設端口即可

以上工具如何安裝自行檢索。

安裝Redis

• RAPA需要部署Redis Server，端口預設即可。建議使用3.0穩定版 下載下傳位址
  • 下載下傳後，解壓縮，進入redis檔案夾，使用make指令完成編譯
    • 執行

      ./src/redis-server

       來啟動Redis Server，若Redis未啟動，RAP會報Redis未啟動的異常。建議使用

      nohup ./src/redis-server &

       來啟動Redis Server，更多用法見官網文檔。

初始化資料庫

執行release分支下的SQL腳本： /src/main/resources/database/initialize.sql，該腳本中包含資料庫建立、表&結建構立、必要的初始資料建立的全部内容。

注意，因最新的mysql的sql_mode設定的比較嚴格，需要手動配置下SQL_MODE來禁止full_group檢查，可以改MySQL配置檔案，或者運作如下SQL語句來修改SQL_MODE：

SET @@global.sql_mode = 'STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION';      

配置檔案

請正确配置

src/config.properties

中的資料庫連接配接位址、使用者名和密碼。

配置context-root （war包部署不需要）

将context-root設定為/，即通路RAP時，必須是http://domain.com/ 而不能是 http://domain.com/rap/。

設定context-root不同的IDE設定方法不一樣，以MyEclipse/Eclipse舉例：

• MyEclipse中，打開項目屬性(Properties), 在Properties -> MyEclipse -> Web -> Web Context-root中，将其修改為/ROOT，以確定RAP部署在tomcat/webapps/ROOT中。
• 如果是Eclipse, Properties -> Web Project Settings -> Context Root 中修改，確定其為ROOT

啟動項目

完成上述步驟，将RAP配置到Tomcat中啟動即可。

注意!RAP暫時僅支援在根目錄部署，若使用編譯好的war包部署，需将war包改名為ROOT.war，以確定RAP部署在webapps/ROOT中！

剩下的就是跟着RAP文檔中心首頁的教程一步一步開啟RAP之旅啦！

常見問題

如何管理團隊

在tb_corporation中自行管理，預設在初始化後隻有一個預設團隊。

如何增加管理者

在tb_role_and_user中添加一條記錄，user_id是管理者的id，role_id是1(超級管理者)或2(管理者)。

如何擷取更新？

我們會確定release的分支上是可用的版本。在開發環境中git pull來擷取最新的源碼更新，每一期更新都會有對應的update.md請關注并按照上面的訓示進行更新工作。

Admin初始密碼是什麼？

由于密碼進行了加密，是以無法直接登入。

使用管理者賬号登陸的方法有很多：

1. 建議自行新增賬號，并按照上面的方式添加管理者權限即可。
2. 随便注冊個小号，設定密碼例如123456，然後将該賬戶的密碼，拷貝的admin的密碼列當中。
3. 如果親使用源代碼自行編譯，可以通過設定PRIVATE_CONFIG.java中的adminPassword字段（萬用密碼）來進行登入。

githup: https://github.com/thx/RAP

預覽位址：http://rap.taobao.org/org/index.do

轉載于:https://www.cnblogs.com/laobaozi/p/6638412.html