Torna

Английский | Китайский

Документация для управления API-интерфейсами предприятия, цель которой — сделать управление документами более удобным и быстрым. Torna использует совместную работу для управления и поддержки проектных API-документов, интегрируя различные формы документов в единый подход к поддержке.

Torna устраняет недостатки традиционных инструментов генерации документов, таких как Swagger, обогащая и улучшая полезные функции, при этом сохраняя оригинальные функции.

Использование

Метод 1: загрузка архива

• Подготовка

  • Java 8+
  • MySQL, требуется версия 5.6.5+, для версий ниже 5.6.5: Поддержка низких версий MySQL

Перейти на страницу Release, загрузить последнюю версию, распаковать

Импортировать базу данных, выполнить mysql.sql

Открыть application.properties, изменить конфигурацию базы данных

Запустить sh startup.sh для запуска. (Для Windows запустить startup.bat)

Посетить: http://ip:7700

• Логин:

имя пользователя: admin, пароль: 123456

• О промежуточном обновлении

Перезаписать файл torna.jar и папку dist, затем запустить.

Метод 2: запуск в Docker

Импортировать базу данных, запустить mysql.sql

Загрузить изображение

docker pull registry.cn-hangzhou.aliyuncs.com/tanghc/torna:latestСоздать пустой файл application.properties для хранения конфигурации:

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

vim /etc/torna/application.properties

внести следующие настройки:

# порт сервера
server.port=7700

# адрес MySQL
mysql.host=<mysql_ip>:3306
# имя базы данных
mysql.schema=torna
# имя пользователя MySQL, убедитесь, что он может выполнять DDL
mysql.username=<username>
mysql.password=<password>

Запустить 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

Посетить через браузер: http://<ip>:7700

Запуск с помощью docker-compose

docker-compose deploy

Запуск с помощью Kubernetes

kubernetes deploy

Рекомендуемое сочетание

smart-doc + Torna

Если вы используете Java, мы рекомендуем использовать smart-doc + Torna

smart-doc + Torna образуют решение для генерации и управления документацией, лидирующее в отрасли. Используя smart-Doc для ненавязчивого извлечения Java-кодов и аннотаций, можно генерировать документацию API и автоматически публиковать её на платформу управления документацией Torna.

С помощью этого сочетания можно достичь следующего: достаточно написать Java-аннотации, чтобы отправить информацию API на платформу Torna, что позволяет просматривать, отлаживать и тестировать API.Отправлять информацию: API имя/автор/параметр пути/заголовок/тело/ответ/словарь/код ошибки

Если вы используете другие языки, вы можете использовать форму страницы для редактирования вышеуказанного содержания, а затем просматривать и отлаживать API.

Разработка и развертывание

См.: Документация разработки

Другие ресурсы

• torna-example, демонстрирует использование плагина Swagger

История изменений

changelog

Предварительный просмотр страницы

Благодарности

Благодарим JetBrains Software за предоставление бесплатной лицензии для этого открытого проекта.