Smart-doc は、JAVA REST API と Apache Duadfdso RPC インターフェイス ドキュメント生成の両方をサポートするツールです。smart-doc は、業界で初めて JAVA の汎用定義に基づいてインターフェイス ドキュメントを分析および生成します。注釈を使用しないインターフェースのソースコードはビジネスコードに侵入します。 Java-doc 標準に従ってコメントを記述するだけでよく、smart-doc を使用すると、Markdown、HTML5、Postman Collection2.0 以降、および OpenAPI 3.0 以降でシンプルで明確なドキュメントを生成できます。
1. アノテーションも学習コストもゼロ。標準の JAVA アノテーションを記述するだけです。
2. ソースコードインターフェイス定義と強力な戻り構造の導出に基づく自動導出。
3. Spring MVC、Spring Boot、Spring Boot Web Flux(コントローラ記述方式)、Feign、JAX-RSをサポート。
4. Callable、Future、CompletableFuture などの非同期インターフェイスからの戻り値の導出をサポートします。
5. JavaBean での JSR303 パラメータ検証仕様 (グループ検証を含む) をサポートします。
6. JSON リクエスト パラメーターのインターフェイスは、シミュレートされた JSON パラメーターを自動的に生成できます。
7. 一部の一般的なフィールド定義では、有効なシミュレーション値を生成できます。
8. JSON 戻り値の例の生成をサポートします。
9. プロジェクト外部からのソースコードの読み込みをサポートし、フィールドコメントを生成します(標準仕様で公開されているjarパッケージを含む)。
10. 複数の形式でのドキュメントの生成をサポート: Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 文書管理システムに自由に接続できるオープンな文書データ。
11. コード内で定義されているエラー コードおよびさまざまな辞書コードのインターフェイス ドキュメントへのエクスポートをサポートします。
12. Maven と Gradle プラグインの簡単な統合をサポートします。
13. Apache Duadfdso RPC インターフェイス ドキュメントの生成をサポートします。
14. デバッグ インターフェイスは HTML5 ページをデバッグし、ファイルのアップロードとダウンロード (@download タグのダウンロード メソッド) テストを完全にサポートします。