Javaマイクロサービスドキュメント生成ツールを共有する

元々、Swaggerはドキュメントを生成できますが、マークダウンファイルをエクスポートすることはできません。このドキュメントジェネレーターは、マークダウンファイルを生成するために使用されます。

コードウェアハウスアドレス：https：//gitee.com/luoye_lj/restful-doc

このツールは、全体として3つの部分に分かれています。つまり、データ構造を確立するためのパッケージスキャン、ドキュメントテンプレート、およびドキュメントテンプレートとデータ構造に基づくドキュメント生成です。データ構造は、インターフェイスグループ、インターフェイス、要求データ、応答データのRESTful構造に分割されます。インターフェイスグループはコントローラファイルに対応し、インターフェイスはコントローラのメソッドに対応します

使い方

1. 倉庫からコードをプルする
2. mavenのinstallコマンドを実行してインストールします
3. プロジェクトに依存関係を追加する

<dependency>
        <groupId>com.luoye.restful</groupId>
        <artifactId>RestfulDoc</artifactId>
        <version>1.0.0</version>
    </dependency>

4. 生成されたコードを書く

package com.luoye;

import com.luoye.restful.DocBuilder;
import com.luoye.restful.PackageScanner;
import com.luoye.restful.model.ApiGroup;

import java.util.List;

public class Test {
    
    

    public static void main(String[] args) {
    
    
        PackageScanner packageScanner=new PackageScanner();
        packageScanner.setScanPackage("com.luoye.test");
        List<ApiGroup> apiGroupList =packageScanner.scan();
        DocBuilder docBuilder=new DocBuilder("测试api文档","api test doc",apiGroupList);
        docBuilder.build();
    }
}

ps

新しいテンプレートディレクトリを作成し、元のテンプレートをコピーして変更してから、生成されたコードでテンプレートディレクトリパスを指定できます。