Слияние кода завершено, страница обновится автоматически
Решение для документации API, цель которого — сделать управление документацией API более удобным и быстрым. Torna использует командный подход для управления и поддержки документации API, объединяя различные формы документов в единое пространство.
Torna устраняет недостатки традиционных инструментов генерации документации (например, Swagger), обогащая и укрепляя некоторые полезные функции при сохранении исходных возможностей.
Если у вас есть вышеуказанные требования и проблемы, возможно, стоит попробовать использовать Torna
Подготовка
Импортируйте базу данных, выполните mysql.sql
Откройте файл конфигурации application.properties, измените настройки подключения к базе данных
Выполните sh startup.sh для запуска (для Windows выполните startup.bat)
Посетите: http://ip:7700
Имя пользователя: admin, пароль: 123456
Если не указано иное, достаточно заменить файл torna.jar и папку dist, а затем перезапустить
Создайте файл конфигурации, выполните команду:
mkdir /etc/torna && wget https://gitee.com/durcframework/torna/raw/master/install/application.properties -O /etc/torna/application.properties
vim /etc/torna/application.properties для изменения настроек подключения к базе данных
Скачайте последнюю версию и запустите
wget https://gitee.com/durcframework/torna/raw/master/install/restart-torna.sh && sh restart-torna.sh 1.31.3
При последующих обновлениях версии достаточно выполнить sh restart-torna.sh номер_версии
Импортируйте базу данных, выполните mysql.sql
Загрузка общего образа
docker pull registry.cn-hangzhou.aliyuncs.com/tanghc/torna:1.31.3
Создание файла конфигурации, выполнение команды:
mkdir /etc/torna && wget https://gitee.com/durcframework/torna/raw/master/install/application.properties -O /etc/torna/application.properties
``````bash
vim /etc/torna/application.properties
Измените конфигурацию подключения к базе данных
Выполнение команды 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:1.31.3
Обратитесь к браузеру по адресу http://ip:7700, где ip соответствует ip-адресу хост-машины Docker, а не ip-адресу контейнера Docker
Развертывание torna с помощью docker-compose
Развертывание torna с помощью Kubernetes
smart-doc + Torna для автоматизации всего цикла документирования
Если вы используете Java, рекомендуется использовать smart-doc + Torna
smart-doc + Torna образуют решение для генерации и управления документацией, лидирующее в отрасли. Используя smart-doc, вы можете безвредно извлекать Java-код и комментарии для создания API-документации, автоматически публикуя документацию на платформу управления документацией Torna.С помощью этой комбинации вы можете реализовать: написание Java-комментариев для отправки информации о конечных точках на платформу Torna, что позволяет просматривать и тестировать конечные точки.Если вы используете язык программирования, отличный от Java, вы можете использовать форму для редактирования вышеуказанного контента, после завершения которого вы также сможете просматривать и тестировать конечные точки.
Добро пожаловать к участию в проекте, PR пожалуйста отправляйте в ветку develop
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.