smart-doc ist ein Tool, das sowohl die JAVA-REST-API als auch die RPC-Schnittstellendokumentgenerierung unterstützt. smart-doc ist das erste in der Branche, das das Konzept der Ableitung basierend auf generischen JAVA-Definitionen vorschlägt Der Quellcode der Schnittstelle kann ohne Verwendung von Anmerkungen in den Geschäftscode eindringen. Sie müssen nur Kommentare gemäß den Java-Doc-Standards schreiben, und Smart-Doc kann Ihnen dabei helfen, ein einfaches und klares Dokument in Markdown, HTML5, Postman Collection2.0+ und OpenAPI 3.0+ zu erstellen.
1. Keine Anmerkungen, keine Lernkosten, schreiben Sie einfach Standard-JAVA-Anmerkungen.
2. Automatische Ableitung basierend auf der Definition der Quellcodeschnittstelle und leistungsstarker Ableitung der Rückgabestruktur.
3. Unterstützt Spring MVC, Spring Boot, Spring Boot Web Flux (Controller-Schreibmethode), Feign und JAX-RS.
4. Unterstützt die Ableitung von Rückgaben von asynchronen Schnittstellen wie Callable, Future und CompletableFuture.
5. Unterstützt die JSR303-Parameterüberprüfungsspezifikation auf JavaBean, einschließlich Gruppenüberprüfung.
6. Die Schnittstelle für JSON-Anfrageparameter kann automatisch simulierte JSON-Parameter generieren.
7. Einige gängige Felddefinitionen können gültige Simulationswerte generieren.
8. Unterstützung beim Generieren von Beispielen für JSON-Rückgabewerte.
9. Unterstützen Sie das Laden von Quellcode von außerhalb des Projekts, um Feldkommentare zu generieren (einschließlich JAR-Paketen, die durch Standardspezifikationen freigegeben werden).
10. Unterstützt die Generierung von Dokumenten in mehreren Formaten: Markdown, HTML5, Asciidoctor, Postman Collection, OpenAPI 3.0. Up- Offene Dokumentdaten, die frei an das Dokumentenverwaltungssystem angeschlossen werden können.
11. Unterstützt den Export von Fehlercodes und verschiedenen im Code definierten Wörterbuchcodes in das Schnittstellendokument.
12. Unterstützt die einfache Integration von Maven- und Gradle-Plug-Ins.
13. Unterstützt die Generierung von Apache Duadfdso RPC-Schnittstellendokumenten.
14. Die Debug-Schnittstelle debuggt die HTML5-Seite und unterstützt das Hochladen und Herunterladen von Dateien (@download tag download method) vollständig.