solution de document d'interface torna v1.29.4

La solution de documents d'interface torna vise à rendre la gestion des documents d'interface plus pratique et plus rapide. Torna utilise la collaboration en équipe pour gérer et maintenir les documents d'interface, et intègre différentes formes de documents dans une maintenance unifiée.

Torna comble les lacunes des outils traditionnels de génération de documents (tels que swagger), en enrichissant et en améliorant certaines fonctions pratiques tout en conservant les fonctions d'origine.

Résoudre les problèmes de gestion des documents

1. Insatisfait de la méthode d'affichage de la page d'aperçu du document swagger et de la page de débogage

2. Je n'aime pas les annotations intrusives comme le fanfaronnade.

3. J'espère utiliser les commentaires javadoc pour générer des documents et effectuer le débogage de l'interface.

4. J'espère que tous les documents d'interface de projet de l'entreprise pourront être gérés de manière uniforme

5. J'espère fournir plusieurs documents du projet à des appelants tiers pour qu'ils puissent les consulter

6. J'espère que l'énumération des dictionnaires dans le projet pourra être gérée de manière uniforme

Étapes d'utilisation

Méthode 1 : Téléchargez le zip et exécutez-le localement

Préparation

Environnement Java, configuration minimale requise Java8

MySQL, nécessite 5.6.5 et versions ultérieures, voir avant 5.6.5 : prend en charge MySQL faible

1. Téléchargez ceci et décompressez le zip

2. Importez la base de données et exécutez mysql.sql

3. Ouvrez le fichier de configuration application.properties et modifiez la configuration de connexion à la base de données.

4. Exécutez sh startup.sh pour démarrer (Windows exécute startup.bat)

5. Visitez : http://ip:7700

Compte de connexion

Nom d'utilisateur : admin, mot de passe : 123456

6. Mises à niveau ultérieures

Aucune instruction particulière, écrasez simplement le fichier torna.jar et le dossier dist, puis redémarrez

Méthode 2 : Docker en cours d’exécution

1. Importez la base de données et exécutez mysql.sql

2. Téléchargez l'image publique

docker pull tanghc2020/torna:1.18.1

3. Créez un fichier vide application.properties sous /etc/torna/ pour stocker la configuration et exécuter la commande

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

4. Modifier le fichier de configuration

vim /etc/torna/application.properties

5. Entrez la configuration suivante

# Port du serveur server.port=7700# Adresse MySQL mysql.host=:3306# Nom de la base de données mysql.schema=torna# Compte de la base de données, assurez-vous que les instructions DDL peuvent être exécutées mysql.username=mysql.password=

Modifier l'adresse et le compte MySQL correspondants

6. Exécutez la commande 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.1

7. Accédez à http://ip:7700 avec le navigateur. L'adresse IP correspond à l'adresse IP de la machine hôte Docker et à l'adresse IP du conteneur non Docker.

Combinaison recommandée

smart-doc + Torna réalise l'automatisation de l'ensemble du processus documentaire

Si vous utilisez le langage Java, il est recommandé d'utiliser smart-doc + Torna

smart-doc + Torna forment une solution de génération et de gestion de documents de pointe. Smart-doc est utilisé pour extraire le code source et les commentaires Java afin de générer des documents API sans intrusion, et de transférer automatiquement les documents vers la plate-forme de gestion de documents d'interface de niveau entreprise Torna. .

Avec cette combinaison, vous pouvez transmettre les informations d'interface vers la plate-forme Torna simplement en écrivant des annotations Java, réalisant ainsi la prévisualisation et le débogage de l'interface.

Si vous utilisez un langage non Java, vous pouvez utiliser la page de formulaire pour modifier le contenu ci-dessus, vous pouvez également prévisualiser et déboguer l'interface.