torna interface document solution v1.29.4

The torna interface document solution aims to make interface document management more convenient and faster. Torna uses team collaboration to manage and maintain interface documents, and incorporates different forms of documents into unified maintenance.

Torna makes up for the shortcomings of traditional document generation tools (such as swagger), enriching and enhancing some practical functions while maintaining the original functions.

Solve document management pain points

1. Unsatisfied with the display method of swagger document preview page and debugging page

2. I don’t like intrusive annotations like swagger.

3. I hope to use javadoc comments to generate documents and perform interface debugging.

4. Hope that all project interface documents of the company can be managed uniformly

5. I hope to provide several documents in the project to third-party callers for viewing

6. Hope that dictionary enumeration in the project can be managed uniformly

Usage steps

Method 1: Download the zip and run it locally

Preparation

Java environment, minimum requirement Java8

MySQL, requires 5.6.5 and later, see before 5.6.5: supports low MySQL

1. Download this and unzip the zip

2. Import the database and execute mysql.sql

3. Open the application.properties configuration file and modify the database connection configuration.

4. Execute sh startup.sh to start (Windows executes startup.bat)

5. Visit: http://ip:7700

Login account

Username: admin, password: 123456

6. Subsequent upgrades

No special instructions, just overwrite the torna.jar file and dist folder, and then restart

Method 2: docker running

1. Import the database and execute mysql.sql

2. Download the public image

docker pull tanghc2020/torna:1.18.1

3. Create an empty file application.properties under /etc/torna/ to store the configuration and execute the command

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

4. Edit configuration file

vim /etc/torna/application.properties

5. Enter the following configuration

# Server port server.port=7700# MySQL address mysql.host=:3306# Database name mysql.schema=torna# Database account, ensure that DDL statements can be executed mysql.username=mysql.password=

Modify the corresponding MySQL address and account

6. Execute docker command

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. Access http://ip:7700 with the browser. The IP corresponds to the docker host machine IP and the non-docker container IP.

Recommended combination

smart-doc + Torna realizes the automation of the entire document process

If you use Java language, it is recommended to use smart-doc + Torna

smart-doc + Torna form an industry-leading document generation and management solution. Smart-doc is used to extract Java source code and comments to generate API documents without intrusion, and automatically push the documents to the Torna enterprise-level interface document management platform.

With this combination, you can push the interface information to the Torna platform just by writing Java annotations, thereby realizing interface preview and interface debugging.

If you are using a non-Java language, you can use the form page to edit the above content. After completion, you can also preview and debug the interface.