torna接口文檔解決方案，目標(biāo)是讓接口文檔管理變得更加方便、快捷。Torna采用團(tuán)隊(duì)協(xié)作的方式管理和維護(hù)接口文檔，將不同形式的文檔納入進(jìn)來統(tǒng)一維護(hù)。

Torna彌補(bǔ)了傳統(tǒng)文檔生成工具(如swagger)的不如之處，在保持原有功能的前提下豐富并增強(qiáng)了一些實(shí)用的功能。

解決文檔管理痛點(diǎn)

1、不滿足swagger文檔預(yù)覽頁面和調(diào)試頁面的展現(xiàn)方式

2、不喜歡swagger這種侵入式注解

3、希望使用javadoc注釋生成文檔，并進(jìn)行接口調(diào)試

4、希望把公司所有項(xiàng)目接口文檔進(jìn)行統(tǒng)一管理

5、希望把項(xiàng)目中的若干文檔提供給第三方調(diào)用者查看

6、希望可以統(tǒng)一管理項(xiàng)目中的字典枚舉

使用步驟

方式1：下載zip本地運(yùn)行

準(zhǔn)備工作

Java環(huán)境，最低要求Java8

MySQL，要求5.6.5及以后，5.6.5之前的版本見：支持低版本MySQL

1、下載最新版本，解壓zip

2、導(dǎo)入數(shù)據(jù)庫，執(zhí)行mysql.sql

3、打開application.properties配置文件，修改數(shù)據(jù)庫連接配置

4、執(zhí)行sh startup.sh啟動(dòng)(Windows執(zhí)行startup.bat)

5、訪問：http://ip:7700

登錄賬號(hào)：

用戶名：admin，密碼：123456

6、后續(xù)升級(jí)

無特殊說明，只需要覆蓋torna.jar文件和dist文件夾，然后重啟即可

方式2：docker運(yùn)行

1、導(dǎo)入數(shù)據(jù)庫，執(zhí)行mysql.sql

2、下載公共鏡像

docker pull tanghc2020/torna:1.18.1

3、在/etc/torna/下創(chuàng)建一個(gè)空文件application.properties用來存放配置，執(zhí)行命令：

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

4、編輯配置文件

vim /etc/torna/application.properties

5、輸入如下配置：

# 服務(wù)器端口

server.port=7700

# MySQL地址

mysql.host=<mysql_ip>:3306

# 數(shù)據(jù)庫名稱

mysql.schema=torna

# 數(shù)據(jù)庫賬號(hào)，確保能執(zhí)行DDL語句

mysql.username=<username>

mysql.password=<password>

修改對(duì)應(yīng)的MySQL地址、賬號(hào)

6、執(zhí)行docker命令：

docker run --name torna --restart=always \

-p 7700:7700 \

-e JAVA_OPTS="-server -Xms512m -Xmx512m" \

-v /etc/torna/application.properties:/torna/config/application.properties \

-d tanghc2020/torna:1.18.1

7、瀏覽器訪問http://ip:7700，ip對(duì)應(yīng)docker宿主機(jī)器ip，非docker容器ip

推薦組合

smart-doc + Torna實(shí)現(xiàn)文檔全流程自動(dòng)化

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

smart-doc + Torna 組成行業(yè)領(lǐng)先的文檔生成和管理解決方案，使用smart-doc無侵入完成Java源代碼和注釋提取生成API文檔，自動(dòng)將文檔推送到Torna企業(yè)級(jí)接口文檔管理平臺(tái)。

通過這套組合您可以實(shí)現(xiàn)：只需要寫完Java注釋就能把接口信息推送到Torna平臺(tái)，從而實(shí)現(xiàn)接口預(yù)覽、接口調(diào)試。

如果您是非Java語言，可以使用表單頁面編輯以上內(nèi)容，完成后同樣可以進(jìn)行接口預(yù)覽、調(diào)試。

更新內(nèi)容

v1.32.0

【新增】導(dǎo)出postman文件

【新增】分享文檔可設(shè)置過期時(shí)間 PR

【新增】用戶管理頁面新增查詢條件(用戶狀態(tài)、是否是超級(jí)管理員) PR

【調(diào)整】推送文檔不會(huì)更改文檔狀態(tài)，由用戶手動(dòng)控制