Torna-Schnittstellen-Dokumentenlösung v1.29.4
1.29.4
Ziel der Interface-Dokumentenlösung von torna ist es, das Interface-Dokumentenmanagement komfortabler und schneller zu gestalten. Torna nutzt Teamzusammenarbeit zur Verwaltung und Pflege von Schnittstellendokumenten und integriert verschiedene Dokumentformen in eine einheitliche Wartung.
Torna gleicht die Mängel herkömmlicher Tools zur Dokumentenerstellung (z. B. Swagger) aus, indem es einige praktische Funktionen bereichert und verbessert und gleichzeitig die ursprünglichen Funktionen beibehält.
1. Unzufrieden mit der Anzeigemethode der Swagger-Dokumentvorschauseite und der Debugging-Seite
2. Ich mag keine aufdringlichen Anmerkungen wie Prahlerei.
3. Ich hoffe, Javadoc-Kommentare verwenden zu können, um Dokumente zu generieren und Schnittstellen-Debugging durchzuführen.
4. Ich hoffe, dass alle Projektschnittstellendokumente des Unternehmens einheitlich verwaltet werden können
5. Ich hoffe, mehrere Dokumente im Projekt Drittanrufern zur Ansicht zur Verfügung stellen zu können
6. Ich hoffe, dass die Wörterbuchaufzählung im Projekt einheitlich verwaltet werden kann
Methode 1: Laden Sie die ZIP-Datei herunter und führen Sie sie lokal aus
Vorbereitung
Java-Umgebung, Mindestanforderung Java8
MySQL erfordert 5.6.5 und höher, siehe vor 5.6.5: unterstützt Low-MySQL
1. Laden Sie dies herunter und entpacken Sie die ZIP-Datei
2. Importieren Sie die Datenbank und führen Sie mysql.sql aus
3. Öffnen Sie die Konfigurationsdatei application.properties und ändern Sie die Datenbankverbindungskonfiguration.
4. Führen Sie sh Startup.sh aus, um zu starten (Windows führt Startup.bat aus).
5. Besuchen Sie: http://ip:7700
Login-Konto
Benutzername: admin, Passwort: 123456
6. Nachfolgende Upgrades
Keine besonderen Anweisungen, überschreiben Sie einfach die Datei torna.jar und den Ordner dist und starten Sie dann neu
Methode 2: Docker läuft
1. Importieren Sie die Datenbank und führen Sie mysql.sql aus
2. Laden Sie das öffentliche Bild herunter
Docker Pull tanghc2020/torna:1.18.13. Erstellen Sie eine leere Datei application.properties unter /etc/torna/, um die Konfiguration zu speichern und den Befehl auszuführen
mkdir /etc/torna && touch /etc/torna/application.properties4. Konfigurationsdatei bearbeiten
vim /etc/torna/application.properties5. Geben Sie die folgende Konfiguration ein
# Server-Port server.port=7700# MySQL-Adresse mysql.host=Ändern Sie die entsprechende MySQL-Adresse und das entsprechende Konto
6. Führen Sie den Docker-Befehl aus
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.17. Greifen Sie mit dem Browser auf http://ip:7700 zu. Die IP entspricht der IP des Docker-Hostcomputers und der IP des Nicht-Docker-Containers.
smart-doc + Torna realisiert die Automatisierung des gesamten Dokumentenprozesses
Wenn Sie die Java-Sprache verwenden, wird die Verwendung von smart-doc + Torna empfohlen
smart-doc + Torna bilden eine branchenführende Lösung zur Dokumentgenerierung und -verwaltung. Smart-doc wird zum Extrahieren von Java-Quellcode und Kommentaren verwendet, um API-Dokumente ohne Eingriff zu generieren und die Dokumente automatisch an die Dokumentenverwaltungsplattform der Unternehmensschnittstelle von Torna zu übertragen .
Mit dieser Kombination können Sie die Schnittstelleninformationen einfach durch das Schreiben von Java-Annotationen auf die Torna-Plattform übertragen und so eine Schnittstellenvorschau und ein Schnittstellen-Debugging realisieren.
Wenn Sie eine Nicht-Java-Sprache verwenden, können Sie den oben genannten Inhalt über die Formularseite bearbeiten. Nach Abschluss können Sie auch eine Vorschau der Benutzeroberfläche anzeigen und diese debuggen.
