143 Star 1.2K Fork 413

tanghc / torna

Create your Gitee Account
Explore and code with more than 8 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
readme.md

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

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 tanghc2020/torna:1.18.2

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 tanghc2020/torna:1.18.2

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

Changelog

changelog

Page preview

API management

Edit API

Preview

Debug API

Acknowledgements

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

About

接口文档解决方案,目标是让接口文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护。 expand collapse
Cancel

Releases (83)

All

torna

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/durcframework/torna.git
git@gitee.com:durcframework/torna.git
durcframework
torna
torna
master

Search