torna介面文件解決方案v1.29.4

torna介面文件解決方案，目標是讓介面文件管理變得更方便、快速。 Torna採用團隊協作的方式管理和維護介面文檔，將不同形式的文檔納入進來統一維護。

Torna彌補了傳統文件產生工具(如swagger)的不如之處，在維持原有功能的前提下豐富並增強了一些實用的功能。

解決文件管理痛點

1.不滿足swagger文件預覽頁面和調試頁面的展現方式

2.不喜歡swagger這種侵入式註解

3.希望使用javadoc註解產生文檔，並進行介面調試

4.希望把公司所有專案介面文件進行統一管理

5.希望把專案中的若干文件提供給第三方呼叫者查看

6.希望可以統一管理專案中的字典枚舉

使用步驟

方式1：下載zip本地運行

準備工作

Java環境，最低要求Java8

MySQL，要求5.6.5及以後，5.6.5之前的見：支援低MySQL

1.下載本，解壓縮zip

2、導入資料庫，執行mysql.sql

3.開啟application.properties設定文件，修改資料庫連線配置

4、執行sh startup.sh啟動(Windows執行startup.bat)

5、瀏覽：http://ip:7700

登入帳號

使用者名稱：admin，密碼：123456

6.後續升級

無特殊說明，只需要覆蓋torna.jar檔和dist資料夾，然後重啟即可

方式2：docker運行

1、導入資料庫，執行mysql.sql

2、下載公共鏡像

docker pull tanghc2020/torna:1.18.1

3.在/etc/torna/下建立一個空文件application.properties用來存放配置，執行指令

mkdir /etc/torna && touch /etc/torna/application.properties

4、編輯設定檔

vim /etc/torna/application.properties

5.輸入如下配置

# 伺服器連接埠server.port=7700# MySQL位址mysql.host=:3306# 資料庫名稱mysql.schema=torna# 資料庫帳號，確保能執行DDL語句mysql.username=mysql.password=

修改對應的MySQL位址、帳號

6.執行docker命令

docker run --name torna --restart=always -p 7700:7700 -e JAVA_OPTS="-server -Xms512m -Xmx512m" -v /etc/torna/application.properties:/torna/config/appli -d tanghc2020/torna:1.18.1

7.瀏覽器訪問http://ip:7700，ip對應docker宿主機器ip，非docker容器ip

推薦組合

smart-doc + Torna實現文件全流程自動化

如果您使用Java語言，推薦使用smart-doc + Torna

smart-doc + Torna 組成業界領先的文件產生和管理解決方案，使用smart-doc無侵入完成Java原始碼和註解提取產生API文檔，自動將文件推送到Torna企業級介面文件管理平台。

透過這套組合您可以實現：只需要寫完Java註解就能把介面資訊推送到Torna平台，從而實現介面預覽、介面調試。

如果您是非Java語言，可以使用表單頁面編輯以上內容，完成後同樣可以進行介面預覽、除錯。