1. Project Overview

Torna

An API documentation solution designed to make API documentation management more convenient and efficient. Torna uses a team collaboration approach to manage and maintain API documentation, bringing documents in different formats together for centralized maintenance.

Torna addresses the shortcomings of traditional documentation generation tools (such as Swagger), enriching and enhancing practical features while retaining the original functionality.

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

Interface Preview

4. Feature Overview

An API documentation solution designed to make API documentation management more convenient and efficient. Torna uses a team collaboration approach to manage and maintain API documentation, bringing documents in different formats together for centralized maintenance.

Solving Documentation Management Pain Points

• Dissatisfied with the presentation of Swagger's documentation preview and debugging pages
• Dislike Swagger's intrusive annotation approach
• Want to generate documentation using Javadoc comments and debug APIs
• Want to centrally manage API documentation for all company projects
• Want to share selected project documents with third-party users
• Want to centrally manage dictionaries and enums used in projects

If you have any of these needs or pain points, you might want to give Torna a try

5. Tech Stack

Usage Instructions

Method 1: Download the ZIP and Run Locally

• Preparation Work
• Java environment, Java 8 or later required
• MySQL 5.6.5 or later required. For versions earlier than 5.6.5, see: Support for Older MySQL Versions

Go to the Releases page, download the latest version, and extract the ZIP file

Import the database by executing mysql.sql

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

Run sh startup.sh to start (on Windows, run startup.bat)

Access: http://ip:7700

• Login credentials:

Username: admin, Password: 123456

• Subsequent Upgrades

Unless otherwise specified, simply replace the torna.jar file and dist folder, then restart

Quick Deployment on a Linux Server

See the README.md documentation for details

Method 2: Run with Docker

See the README.md documentation for details

Recommended Combination

Automate the Entire Documentation Workflow with smart-doc + Torna

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

smart-doc + Torna Integration Tutorial

smart-doc + Torna form an industry-leading documentation generation and management solution. smart-doc extracts Java source code and comments without intrusive modifications to generate API documentation, then automatically pushes the documentation to the Torna enterprise-grade API documentation management platform.

With this combination, you only need to write Java comments and the API information can be pushed to the Torna platform, enabling API previews and debugging.

If you use a non-Java language, you can edit the above content through the form interface and still preview and debug APIs once completed.