# torna

**Repository Path**: zhanglim/torna

## Basic Information

- **Project Name**: torna
- **Description**: 企业接口文档解决方案，目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档，将不同形式的文档纳入进来，形成一个统一的维护方式。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://torna.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 647
- **Created**: 2022-07-13
- **Last Updated**: 2022-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Torna

English | [简体中文](readme_CN.md)

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.

<img src="./front/public/static/images/arc2.png" width="80%" height="80%" />

## Current version

| Module |                                     Version                                     |
| :----: |:-------------------------------------------------------------------------------:|
| sdk-java |       ![maven](https://img.shields.io/maven-central/v/cn.torna/torna-sdk)       |
| swagger-plugin |    ![maven](https://img.shields.io/maven-central/v/cn.torna/swagger-plugin)     |
| smart-doc | ![maven](https://img.shields.io/maven-central/v/com.github.shalousun/smart-doc) |


## Usage

### Method 1:download zip

- Prepare

  - Java8+
  - MySQL,need 5.6.5+,before 5.6.5:[Support low version for MySQL](http://torna.cn/dev/mysql-lower-version.html)

Go [Release page](https://github.com/torna-group/torna/releases) ,download latest version,unzip

Import database,execute [mysql.sql](./mysql.sql)

Open`application.properties`,modify database config

Run`sh 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](./mysql.sql)

Download image

`docker pull tanghc2020/torna:latest`

Run docker:

```
docker run --name torna --restart=always \
  -p 7700:7700 \
  -e JAVA_OPTS="-Xms256m -Xmx256m" \
  -e MYSQL_HOST="172.16.60.102:3306" \
  -e MYSQL_SCHEMA="torna" \
  -e MYSQL_USERNAME="root" \
  -e MYSQL_PASSWORD="root" \
  -d tanghc2020/torna:1.15.7
```

Need modify：

- MYSQL_HOST：MySQL host
- MYSQL_SCHEMA：database name
- MYSQL_USERNAME：MySQL username,make sure the account can run CREATE/ALTER sql.
- MYSQL_PASSWORD：MySQL password


Visit:`http://ip:7700`


### docker-compose deploy
[docker-compose deploy](https://gitee.com/durcframework/torna/tree/master/torna-docker-compose)

### kubernetes deploy
[kubernetes deploy](https://gitee.com/durcframework/torna/tree/master/torna-on-kubernetes)

## Recommended combination

**smart-doc + Torna**

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

[smart-doc](https://github.com/smart-doc-group/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](http://torna.cn/dev/)

## Other resource

- [torna-example](https://gitee.com/durcframework/torna-example) ,show usage of swagger-plugin

## Changelog

[changelog](./changelog.md)


## Page preview

![API management](./front/public/static/images/table.png "table.png")

![Edit API](./front/public/static/images/edit.png "edit.png")

![Preview](./front/public/static/images/view.png "view.png")

![Debug API](./front/public/static/images/debug.png "debug.png")

## Acknowledgements
Thanks to [JetBrains SoftWare](https://www.jetbrains.com) for providing free Open Source license for this open source project.
<img src="https://raw.githubusercontent.com/shalousun/smart-doc/dev/images/jetbrains-variant-3.png" width="260px" height="220px"/>