torna 인터페이스 문서 솔루션은 인터페이스 문서 관리를 보다 편리하고 빠르게 만드는 것을 목표로 합니다. Torna는 팀 협업을 통해 인터페이스 문서를 관리 및 유지하고 다양한 형태의 문서를 통합 유지 관리에 통합합니다.
Torna는 전통적인 문서 생성 도구(예: Swagger)의 단점을 보완하여 원래 기능을 유지하면서 일부 실용적인 기능을 풍부하게 하고 향상시킵니다.
1. Swagger 문서 미리보기 페이지 및 디버깅 페이지 표시 방식이 불만족스럽습니다.
2. 나는 swagger와 같은 거슬리는 주석을 좋아하지 않습니다.
3. javadoc 주석을 사용하여 문서를 생성하고 인터페이스 디버깅을 수행하고 싶습니다.
4. 회사의 모든 프로젝트 인터페이스 문서를 통일적으로 관리할 수 있기를 바랍니다.
5. 프로젝트의 여러 문서를 제3자 발신자에게 제공하여 볼 수 있도록 하고 싶습니다.
6. 프로젝트 내 사전 열거를 통일적으로 관리할 수 있기를 바랍니다.
방법 1: zip을 다운로드하고 로컬에서 실행
준비
Java 환경, 최소 요구 사항 Java8
MySQL, 5.6.5 이상이 필요합니다. 5.6.5 이전 참조: 낮은 MySQL 지원
1. 다운로드 후 압축을 푼다
2. 데이터베이스를 가져오고 mysql.sql을 실행합니다.
3. application.properties 구성 파일을 열고 데이터베이스 연결 구성을 수정합니다.
4. sh start.sh를 실행하여 시작합니다. (Windows에서는 start.bat를 실행합니다.)
5. 방문: http://ip:7700
로그인 계정
사용자 이름: admin, 비밀번호: 123456
6. 후속 업그레이드
특별한 지침은 없습니다. torna.jar 파일과 dist 폴더를 덮어쓴 다음 다시 시작하면 됩니다.
방법 2: 도커 실행
1. 데이터베이스를 가져오고 mysql.sql을 실행합니다.
2. 공개 이미지 다운로드
도커 풀 tanghc2020/torna:1.18.13. /etc/torna/ 아래에 빈 파일 application.properties를 생성하여 구성을 저장하고 명령을 실행합니다.
mkdir /etc/torna && touch /etc/torna/application.properties4. 구성 파일 편집
정력 /etc/torna/application.properties5. 다음 구성을 입력하십시오
# 서버 포트 server.port=7700# MySQL 주소 mysql.host=해당 MySQL 주소 및 계정 수정
6. 도커 명령 실행
docker run --name torna --restart=always -p 7700:7700 -e JAVA_OPTS="-server -Xms512m -Xmx512m" -v /etc/torna/application.properties:/torna/config/application.properties -d tanghc2020/torna:1.18.17. 브라우저를 통해 http://ip:7700에 접속합니다. IP는 Docker 호스트 머신 IP와 Docker가 아닌 컨테이너 IP에 해당합니다.
smart-doc + Torna는 전체 문서 프로세스의 자동화를 실현합니다.
Java 언어를 사용하는 경우 smart-doc + Torna 사용을 권장합니다.
smart-doc + Torna는 업계 최고의 문서 생성 및 관리 솔루션을 구성합니다. Smart-doc는 Java 소스 코드와 주석을 추출하여 침입 없이 API 문서를 생성하고 해당 문서를 Torna 엔터프라이즈급 인터페이스 문서 관리 플랫폼에 자동으로 푸시하는 데 사용됩니다. .
이 조합을 사용하면 Java 주석을 작성하는 것만으로 인터페이스 정보를 Torna 플랫폼에 푸시할 수 있으므로 인터페이스 미리보기 및 인터페이스 디버깅이 실현됩니다.
Java 이외의 언어를 사용하는 경우 양식 페이지를 사용하여 위 내용을 편집한 후 인터페이스를 미리 보고 디버깅할 수도 있습니다.