torna インターフェース文書ソリューションは、インターフェース文書管理をより便利かつ迅速にすることを目的としています。 Torna は、チームのコラボレーションを使用してインターフェース文書を管理および保守し、さまざまな形式の文書を統合保守に組み込みます。
Torna は、従来の文書生成ツール (swagger など) の欠点を補い、オリジナルの機能を維持しつつ、いくつかの実用的な機能を強化および強化します。
1. Swagger ドキュメントのプレビュー ページとデバッグ ページの表示方法に不満
2. 私は威張ったような押し付けがましい注釈は好きではありません。
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. shstartup.shを実行して起動します(Windowsはstartup.batを実行します)。
5. アクセス: http://ip:7700
ログインアカウント
ユーザー名: 管理者、パスワード: 123456
6. その後のアップグレード
特に指示はなく、torna.jarファイルとdistフォルダを上書きして再起動するだけです。
方法 2: Docker の実行
1. データベースをインポートし、mysql.sql を実行します。
2. 公開イメージをダウンロードする
docker pull Tanghc2020/torna:1.18.13. /etc/torna/ に空のファイル application.properties を作成し、設定を保存し、コマンドを実行します。
mkdir /etc/torna && touch /etc/torna/application.properties4. 設定ファイルの編集
vim /etc/torna/application.properties5. 次の設定を入力します
# サーバーポートserver.port=7700# MySQLアドレスmysql.host=対応する 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/application.properties -d tanghc2020/torna:1.18.17. ブラウザで 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 以外の言語を使用している場合は、完了後にフォーム ページを使用して上記のコンテンツを編集し、インターフェイスをプレビューおよびデバッグすることもできます。