Enterprise-class open source interface documentation solution – torna

Enterprise-class open source interface documentation solution – torna

2022-09-02 0 1,476
Resource Number 37466 Last Updated 2025-02-24
¥ 0HKD Upgrade VIP
Download Now Matters needing attention
Can't download? Please contact customer service to submit a link error!
Value-added Service: Installation Guide Environment Configuration Secondary Development Template Modification Source Code Installation

This issue features torna, an enterprise interface documentation solution.

Torna is an enterprise interface document solution that aims to make document management easier and faster. Torna uses a team approach to manage and maintain project API documentation, incorporating different forms of documentation to form a unified maintenance approach.

3e61bd9117f2424b85cccc0ff717c15fnoop.image_

Torna compensates for the shortcomings of traditional document generation tools such as swagger, enriching and enhancing some useful features while maintaining the original functionality:

Basics: Add, delete, modify, preview documents, import and export, document sorting, dictionary management
Enhancements: multi-environment debugging, Mock data, document aggregation, document sharing, rights management, global Settings, docker running, Chinese/English switching, User Center
Extensions: Smart-doc push, swagger plugin push, external document access, OpenAPI/SDK push
Login: third-party interface login, LDAP login, OAuth login, Nailing password free login

daac7fb487ad48de95b471309ede3f87noop.image_

Use steps:

Method 1: Download the zip file and run it locally

1. Prepare

Java environment. The minimum requirement is Java8
MySQL 5.6.5 and later. For versions earlier than 5.6.5, see: Support MySQL | Torna

2. Go to Links, download the latest version, and decompress zip

3. Import the database and run mysql.sql · tanghc/ torna-Gitee.com

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

5. Run sh startup.sh to start the startup. (Run startup.bat on Windows.)

6. Visit http://ip:7700 with your browser

7. There are no special instructions for subsequent upgrade. You only need to overwrite the torna.jar file and dist folder, and then restart

Method 2: docker run

1. Download the public image

docker pull tanghc2020/torna:latest

2

Import the database and run mysql.sql · tanghc/ torna-Gitee.com

3. The replication server/boot/SRC/main/resources/application. The properties files into the/opt/torna/config, change the database connection configuration

4. Perform docker run – name torna -p 7700:7700 – v/opt/torna/config: / torna/config – d < mirror ID >

5. Visit http://ip:7700 with your browser

Development and deployment:

1. Development environment

Before embarking on development, please install/learn the following environment in advance

Java8, Torna requires a minimum Java version of Java8
Maven3, package management and build tools, minimum version required maven3
nodejs12: Front-end development requires nodejs installation. The recommended version is NodeJS12
Mysql5.7(Recommended)

Engineering description

front: Front-end engineering
plugin: plugin
script: auxiliary script
sdk: indicates the SDK corresponding to OpenAPI
server: Server project
mysql: database script

2. Import the project

This project is developed using IDEA, and Eclipse can theoretically support it.

Because Torna is based on SpringBoot, it can be developed using the community version of IDEA.

The import procedure is as follows:

Run the mysql.sql script in MySQL5.6.5 and later versions. For versions earlier than 5.6.5, see: MySQL | Torna is supported
The IDE installs the lombok plugin, then opens the project (you can open the root pom.xml under IDEA, then open as project), the first import will download the dependency package, please be patient
Open the server/boot/SRC/main/resources/application properties, change the database configuration
Run server/boot/SRC/main/Java/cn/torna TornaApplication. Java

At this point, the server is started, and the following explains the front-end project

Running front end

cd front, jump the command prompt to the front directory

Run npm install

This step is to download the nodejs dependencies

run npm run dev and go to http://localhost:9530/

At this point, the front end starts up

The server address for the front-end request is configured in the.env.development file, which defaults to http://localhost:7700

The IDE opens the front-end project

Use WebStorm or VSCode to open the front folder, if you are a backend Java developer, WebStorm is recommended, the interface is a little familiar, and the family bucket shortcut is the same.

Interface preview:

Document management

f7b534643f0346b6ba8f9c61f50c27dcnoop.image_

document editing

df7e528189fa4bb590b3bf93e3f1ef16noop.image_

Document preview

8449384a7b734a5caea362c9f21608f3noop.image_

interface debugging

eadb21dbb124404a8ccd417dbd3bfba5noop.image_

upload files

0ff61c0f311742deaf61e93a8cd9099cnoop.image_

You can read more on your own.

Open source address: Click download

If you need project recommendations and resources, please send private letters to the author

资源下载此资源为免费资源立即下载
Telegram:@John_Software

Disclaimer: This article is published by a third party and represents the views of the author only and has nothing to do with this website. This site does not make any guarantee or commitment to the authenticity, completeness and timeliness of this article and all or part of its content, please readers for reference only, and please verify the relevant content. The publication or republication of articles by this website for the purpose of conveying more information does not mean that it endorses its views or confirms its description, nor does it mean that this website is responsible for its authenticity.

Ictcoder Free Source Code Enterprise-class open source interface documentation solution – torna https://ictcoder.com/enterprise-class-open-source-interface-documentation-solution-torna/

Share free open-source source code

Q&A
  • 1. Automatic: After making an online payment, click the (Download) link to download the source code; 2. Manual: Contact the seller or the official to check if the template is consistent. Then, place an order and make payment online. The seller ships the goods, and both parties inspect and confirm that there are no issues. ICTcoder will then settle the payment for the seller. Note: Please ensure to place your order and make payment through ICTcoder. If you do not place your order and make payment through ICTcoder, and the seller sends fake source code or encounters any issues, ICTcoder will not assist in resolving them, nor can we guarantee your funds!
View details
  • 1. Default transaction cycle for source code: The seller manually ships the goods within 1-3 days. The amount paid by the user will be held in escrow by ICTcoder until 7 days after the transaction is completed and both parties confirm that there are no issues. ICTcoder will then settle with the seller. In case of any disputes, ICTcoder will have staff to assist in handling until the dispute is resolved or a refund is made! If the buyer places an order and makes payment not through ICTcoder, any issues and disputes have nothing to do with ICTcoder, and ICTcoder will not be responsible for any liabilities!
View details
  • 1. ICTcoder will permanently archive the transaction process between both parties and snapshots of the traded goods to ensure the authenticity, validity, and security of the transaction! 2. ICTcoder cannot guarantee services such as "permanent package updates" and "permanent technical support" after the merchant's commitment. Buyers are advised to identify these services on their own. If necessary, they can contact ICTcoder for assistance; 3. When both website demonstration and image demonstration exist in the source code, and the text descriptions of the website and images are inconsistent, the text description of the image shall prevail as the basis for dispute resolution (excluding special statements or agreements); 4. If there is no statement such as "no legal basis for refund" or similar content, any indication on the product that "once sold, no refunds will be supported" or other similar declarations shall be deemed invalid; 5. Before the buyer places an order and makes payment, the transaction details agreed upon by both parties via WhatsApp or email can also serve as the basis for dispute resolution (in case of any inconsistency between the agreement and the description of the conflict, the agreement shall prevail); 6. Since chat records and email records can serve as the basis for dispute resolution, both parties should only communicate with each other through the contact information left on the system when contacting each other, in order to prevent the other party from denying their own commitments. 7. Although the probability of disputes is low, it is essential to retain important information such as chat records, text messages, and email records, in case a dispute arises, so that ICTcoder can intervene quickly.
View details
  • 1. As a third-party intermediary platform, ICTcoder solely protects transaction security and the rights and interests of both buyers and sellers based on the transaction contract (product description, agreed content before the transaction); 2. For online trading projects not on the ICTcoder platform, any consequences are unrelated to this platform; regardless of the reason why the seller requests an offline transaction, please contact the administrator to report.
View details

Related Source code

ICTcoder Customer Service

24-hour online professional services