solução de documento de interface torna v1.29.4

A solução de documentos de interface torna visa tornar o gerenciamento de documentos de interface mais conveniente e rápido. Torna utiliza a colaboração em equipe para gerenciar e manter documentos de interface e incorpora diferentes formas de documentos na manutenção unificada.

Torna compensa as deficiências das ferramentas tradicionais de geração de documentos (como o swagger), enriquecendo e aprimorando algumas funções práticas, mantendo as funções originais.

Resolva os problemas do gerenciamento de documentos

1. Insatisfeito com o método de exibição da página de visualização do documento swagger e da página de depuração

2. Não gosto de anotações intrusivas, como arrogância.

3. Espero usar comentários javadoc para gerar documentos e realizar depuração de interface.

4. Esperamos que todos os documentos de interface do projeto da empresa possam ser gerenciados uniformemente

5. Espero fornecer vários documentos do projeto a terceiros para visualização

6. Espero que a enumeração do dicionário no projeto possa ser gerenciada de maneira uniforme

Etapas de uso

Método 1: Baixe o zip e execute-o localmente

Preparação

Ambiente Java, requisito mínimo Java8

MySQL, requer 5.6.5 e posterior, veja antes de 5.6.5: suporta MySQL baixo

1. Baixe e descompacte o zip

2. Importe o banco de dados e execute mysql.sql

3. Abra o arquivo de configuração application.properties e modifique a configuração da conexão com o banco de dados.

4. Execute sh startup.sh para iniciar (o Windows executa startup.bat)

5. Visite: http://ip:7700

Conta de login

Nome de usuário: administrador, senha: 123456

6. Atualizações subsequentes

Sem instruções especiais, apenas sobrescreva o arquivo torna.jar e a pasta dist e reinicie

Método 2: janela de encaixe em execução

1. Importe o banco de dados e execute mysql.sql

2. Baixe a imagem pública

docker pull tanghc2020/torna:1.18.1

3. Crie um arquivo vazio application.properties em /etc/torna/ para armazenar a configuração e executar o comando

mkdir /etc/torna && touch /etc/torna/application.properties

4. Edite o arquivo de configuração

vim /etc/torna/application.properties

5. Insira a seguinte configuração

# Porta do servidor server.port=7700# Endereço MySQL mysql.host=:3306# Nome do banco de dados mysql.schema=torna# Conta do banco de dados, certifique-se de que as instruções DDL possam ser executadas mysql.username=mysql.password=

Modifique o endereço e a conta MySQL correspondentes

6. Execute o comando docker

docker run --name torna --restart=sempre -p 7700:7700 -e JAVA_OPTS="-server -Xms512m -Xmx512m" -v /etc/torna/application.properties:/torna/config/application.properties -d tanghc2020/torna:1.18.1

7. Acesse http://ip:7700 com o navegador. O IP corresponde ao IP da máquina host do docker e ao IP do contêiner não-docker.

Combinação recomendada

smart-doc + Torna realiza a automação de todo o processo documental

Se você usa a linguagem Java, é recomendado usar smart-doc + Torna

smart-doc + Torna formam uma solução de geração e gerenciamento de documentos líder do setor. Smart-doc é usado para extrair código-fonte Java e comentários para gerar documentos API sem intrusão e enviar automaticamente os documentos para a plataforma de gerenciamento de documentos de interface de nível empresarial Torna. .

Com essa combinação, você pode enviar as informações da interface para a plataforma Torna apenas escrevendo anotações Java, realizando assim a visualização e a depuração da interface.

Se você estiver usando uma linguagem não Java, poderá usar a página do formulário para editar o conteúdo acima. Após a conclusão, você também poderá visualizar e depurar a interface.