Решение для документов интерфейса Torna v1.29.4

Решение для документов интерфейса Torna направлено на то, чтобы сделать управление документами интерфейса более удобным и быстрым. Torna использует совместную работу команды для управления и обслуживания интерфейсных документов, а также объединяет различные формы документов в единое обслуживание.

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

Решение проблем документооборота

1. Неудовлетворен методом отображения страницы предварительного просмотра документа Swagger и страницы отладки.

2. Не люблю навязчивых аннотаций типа чванливости.

3. Я надеюсь использовать комментарии Javadoc для создания документов и выполнения отладки интерфейса.

4. Надеемся, что всеми проектными документами компании можно будет управлять единообразно.

5. Надеюсь предоставить для просмотра сторонним звонилкам несколько документов в проекте

6. Надеюсь, что перечислением по словарям в проекте можно будет управлять единообразно.

Этапы использования

Способ 1. Загрузите zip-архив и запустите его локально.

Подготовка

Среда Java, минимальные требования Java8

MySQL, требуется 5.6.5 и более поздние версии, см. выше 5.6.5: поддерживает MySQL низкого уровня.

1. Загрузите это и разархивируйте zip-архив.

2. Импортируйте базу данных и запустите mysql.sql.

3. Откройте файл конфигурации application.properties и измените конфигурацию подключения к базе данных.

4. Для запуска выполните sh start.sh (Windows запускает файл start.bat).

5. Посетите: http://ip:7700.

Вход в аккаунт

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

6. Последующие обновления

Никаких специальных инструкций, просто перезапишите файл Torna.jar и папку dist, а затем перезапустите.

Способ 2: запуск докера

1. Импортируйте базу данных и запустите mysql.sql.

2. Загрузите общедоступное изображение

docker pull tanghc2020/torna:1.18.1

3. Создайте пустой файл application.properties в /etc/torna/ для хранения конфигурации и выполните команду.

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

4. Отредактируйте файл конфигурации.

vim /etc/torna/application.properties

5. Введите следующую конфигурацию

# Порт сервера server.port=7700# Адрес MySQL mysql.host=:3306# Имя базы данных mysql.schema=torna# Учетная запись базы данных, убедитесь, что операторы DDL могут выполняться mysql.username=mysql.password= <пароль>

Измените соответствующий адрес и учетную запись MySQL.

6. Выполните команду докера.

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.1

7. Откройте http://ip:7700 с помощью браузера. IP-адрес соответствует IP-адресу хост-компьютера Docker и IP-адресу контейнера без Docker.

Рекомендуемая комбинация

smart-doc + Torna реализует автоматизацию всего документооборота

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

smart-doc + Torna представляет собой ведущее в отрасли решение для создания и управления документами. Smart-doc используется для извлечения исходного кода Java и комментариев для создания документов API без вмешательства и автоматической отправки документов на платформу управления документами интерфейса корпоративного уровня Torna. .

С помощью этой комбинации вы можете передать информацию об интерфейсе на платформу Torna, просто написав аннотации Java, тем самым реализуя предварительный просмотр и отладку интерфейса.

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