Compartilhe uma ferramenta de geração de documentos de microsserviço java

Originalmente, o swagger pode gerar documentos, mas não pode exportar arquivos markdown. Este gerador de documentos é usado para gerar arquivos markdown.

Endereço do armazém de códigos: https://gitee.com/luoye_lj/restful-doc

A ferramenta é dividida em três partes como um todo, a saber, digitalização de pacotes para estabelecer a estrutura de dados, o modelo do documento e a geração do documento com base no modelo e na estrutura de dados do documento. A estrutura de dados é dividida em estrutura restful: grupo de interface, interface, dados de solicitação, dados de resposta. O grupo de interface corresponde a um arquivo do controlador, e a interface corresponde ao método no controlador

Como usar

1. Retire o código do armazém
2. Execute o comando de instalação do maven para instalar
3. Adicionar dependências ao projeto

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

4. Escreva o código gerado

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

Você pode criar um novo diretório de modelo, copiar o modelo original nele para modificação e, em seguida, especificar o caminho do diretório de modelo no código gerado