thc75 / torna

API document solution, the goal is to make the document management become more convenient and fast

Torna

English | 简体中文

Enterprise API document solution, the goal is to make the document management become more convenient, fast. Torna takes a collaborative approach to managing and maintaining project API documents, incorporating different forms of documents into a unified maintenance approach.

Torna makes up for the shortcomings of traditional document generation tools such as Swagger by enriching and enhancing some useful functionality while maintaining the original functionality.

Usage

Method 1:download zip

• Prepare

  • Java8+
  • MySQL,need 5.6.5+,before 5.6.5:Support low version for MySQL

Go Release page ,download latest version,unzip

Import database,execute mysql.sql

Openapplication.properties,modify database config

Runsh startup.sh to startup.(Windows run startup.bat)

Visit:http://ip:7700

• Login account:

username:admin，password:123456

• About upgrade

Override torna.jar file and dist folder,and startup.

Method 2: run in docker

Import database,run mysql.sql

Download image

docker pull registry.cn-hangzhou.aliyuncs.com/tanghc/torna:latest

Create an empty file application.properties to store config：

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

vim /etc/torna/application.properties

entry config below:

# server port
server.port=7700

# MySQL address
mysql.host=<mysql_ip>:3306
# Database name
mysql.schema=torna
# MySQL account, make sure can run DDL
mysql.username=<username>
mysql.password=<password>

Run 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 registry.cn-hangzhou.aliyuncs.com/tanghc/torna:latest

Browser visit:http://<ip>:7700

docker-compose deploy

docker-compose deploy

kubernetes deploy

kubernetes deploy

Recommended combination

smart-doc + Torna

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

smart-doc + Torna form an industry-leading document generation and management solution, using smart-Doc non-intrusive Java source code and annotation extraction to generate API documents, automatically push documents to Torna enterprise interface document management platform. Through this combination you can achieve: only need to write Java annotation can push the API information to the Torna platform, so as to achieve interface preview, interface debugging.

Push content:API name/author/path param/header/body/response/dict/error code

If you use other language, you can use the form page to edit the above content, and then you can also preview and debug the API.

Development and deployment

See:Development document

Other resource

• torna-example ,show usage of swagger-plugin

Changelog

changelog

Page preview

Acknowledgements

Thanks to JetBrains SoftWare for providing free Open Source license for this open source project.