标签: torna接口文档解决方案
torna接口文档解决方案,目标是让接口文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护。
Torna弥补了传统文档生成工具(如swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。
1、不满足swagger文档预览页面和调试页面的展现方式
2、不喜欢swagger这种侵入式注解
3、希望使用javadoc注释生成文档,并进行接口调试
4、希望把公司所有项目接口文档进行统一管理
5、希望把项目中的若干文档提供给第三方调用者查看
6、希望可以统一管理项目中的字典枚举
方式1:下载zip本地运行
准备工作
Java环境,最低要求Java8
MySQL,要求5.6.5及以后,5.6.5之前的版本见:支持低版本MySQL
1、下载最新版本,解压zip
2、导入数据库,执行mysql.sql
3、打开application.properties配置文件,修改数据库连接配置
4、执行sh startup.sh启动(Windows执行startup.bat)
5、访问:http://ip:7700
登录账号:
用户名:admin,密码:123456
6、后续升级
无特殊说明,只需要覆盖torna.jar文件和dist文件夹,然后重启即可
方式2:docker运行
1、导入数据库,执行mysql.sql
2、下载公共镜像
docker pull tanghc2020/torna:1.18.1
3、在/etc/torna/下创建一个空文件application.properties用来存放配置,执行命令:
mkdir /etc/torna && touch /etc/torna/application.properties
4、编辑配置文件
vim /etc/torna/application.properties
5、输入如下配置:
# 服务器端口
server.port=7700
# MySQL地址
mysql.host=<mysql_ip>:3306
# 数据库名称
mysql.schema=torna
# 数据库账号,确保能执行DDL语句
mysql.username=<username>
mysql.password=<password>
修改对应的MySQL地址、账号
6、执行docker命令:
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.1
7、浏览器访问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语言,可以使用表单页面编辑以上内容,完成后同样可以进行接口预览、调试。
加载全部内容
MaxKey单点登录认证系统 官方版20.59MB108人下载 MaxKey(马克思的钥匙)用户单点登录认证系统(Sigle Sign On System),寓意是最大钥匙,是业界领先的企业级IAM身份管理和身份认证产品,支持OAuth 2.0/OpenID Connect、SAML 2.0、JWT、CAS等标准化的开放协议,提供简单、标准、安全和开放的用户身份管理(IDM)、身份认证(AM)、单点登录(SSO)、RBAC权限管理和资源管理等。
下载bishengjdk-8 毕昇JDK8131.38MB107人下载毕昇JDK 8是华为内部OpenJDK定制版Huawei JDK的开源版本,是一个高性能、可用于生产环境的OpenJDK发行版。Huawei JDK运行在华为内部500多个产品上,积累了大量使用场景和java开发者反馈的问题和诉求,解决了业务实际运行中遇到的多个问题,并在ARM架构上进行了性能优化,毕昇JDK运行在大数据等场景下可以获得更好的性能。毕昇JDK 8与Java SE标准兼容,目前仅支持
下载Jpom 监控管理系统 正式版1.55MB106人下载Jpom项目监控软件是一款简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件。Jpom项目监控软件主要功能及特点:1、创建、修改、删除项目、Jar包管理2、实时查看控制台日志、备份日志、删除日志、导出日志3、cpu、ram 监控、导出堆栈信息、查看项目进程端口、服务器状态监控4、多节点管理、多节点自动分发5、实时监控项目状态异常自动报警6、在线构建项目发布项目一键搞定7、多用户管理,用户项
下载jdchain 区块链框架系统943KB105人下载京东区块链 JD Chain 是一个企业级的区块链框架系统,具有简洁、易用、可扩展和高性能的特点。 核心实现采用 Java 语言,学习门槛低,运维简便,无缝兼容企业应用IT架构。 这是主项目仓库,主要包括了文档和集成打包的结构,以及多个Git子模块仓库framework, core, explore 等。JD Chain 的目标是实现一个面向企业应用场景的通用区块链框架系统,能够作为企业级基础设施
下载Jenkins持续集成引擎 正式版17.87MB105人下载 Jenkins持续集成引擎的前身是Hudson是一个可扩展的持续集成引擎。Jenkins是一款开源CI&CD软件,用于自动化各种任务,包括构建、测试和部署软件。Jenkins支持各种运行方式,可通过系统包、Docker或者通过一个独立的Java程序。
下载SkyWalking应用性能监控系统4.16MB105人下载SkyWalking 是一款开源的应用性能监控系统,包括指标监控,分布式追踪,分布式系统性能诊断。功能:1、服务,服务实例,端点指标分析2、根本原因分析。在运行时分析代码。阅读Apache SkyWalking:使用性能分析来修复分布式跟踪的盲点。3、服务拓扑图分析4、服务,服务实例和端点依赖关系分析5、检测到慢速服务和端点6、性能优化7、分布式跟踪和上下文传播8、数据库访问指标。检测慢速数据库访
下载kkFileView在线预览 最新版286.18MB103人下载 kkFileView在线预览是一款使用spring boot打造的文件文档在线预览项目解决方案,支持doc、docx、ppt、pptx、xls、xlsx、zip、rar、mp4、mp3以及众多类文本如txt、html、xml、java、properties、sql、js、md、json、conf、ini、vue、php、py、bat、gitignore等文件在线预览。项目特性:支持office,p
下载ApacheMaven项目构建工具4.41MB103人下载Apache Maven项目构建工具是一个流行的Java项目构建系统。目前,绝大多数开发人员都把Ant当作Java编程项目的标准构建工具。遗憾的是,Ant的项目管理工具(作为make的替代工具)不能满足绝大多数开发人员的需要。通过检查Ant构建文件,很难发现项目的相关性信息和其它元信息(如开发人员/拥有者、版本或站点主页)。Maven除了以程序构建能力为特色之外,还提供Ant所缺少的高级项目管理工
下载Monibuca流媒体服务器开发框架29KB102人下载Monibuca是一个开源的流媒体服务器开发框架,适用于快速定制化开发流媒体服务器,可以对接CDN厂商,作为回源服务器,也可以自己搭建集群部署环境。丰富的内置插件提供了流媒体服务器的常见功能,例如rtmpserver、http-flv、视频录制、QoS等。除此以外还内置了后台web界面,方便观察服务器运行的状态。也可以自己开发后台管理界面,通过api方式获取服务器的运行信息。Monibuca提供了
下载kkFileView在线预览 官方版184.50MB102人下载 kkFileView在线预览是一款使用spring boot打造的文件文档在线预览项目解决方案,支持doc、docx、ppt、pptx、xls、xlsx、zip、rar、mp4、mp3以及众多类文本如txt、html、xml、java、properties、sql、js、md、json、conf、ini、vue、php、py、bat、gitignore等文件在线预览。
下载