企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。Torna弥补了传统文档生成工具(如swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。本文将讲讲torna接口文档管理工具的功能特性,及如何将本地内网api或web或应用利用nat123让外网访问的实现。
torna接口文档解决方案的一些功能:
1,文档管理
支持接口文档增删改查、导入导出、OpenAPI接入、字典管理、接口调试
2,权限管理
以项目组的形式管理接口,各项目组之间接口互不影响,同时有访客、开发者、管理员三种角色,每种角色有用不同权限
3,双模式
提供【管理模式】、【浏览模式】双模式,管理模式用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰
torna解决文档管理痛点:
不满足swagger文档预览页面和调试页面的展现方式
不喜欢swagger这种侵入式注解
希望使用javadoc注释生成文档,并进行接口调试
希望把公司所有项目接口文档进行统一管理
希望把项目中的若干文档提供给第三方调用者查看
希望可以统一管理项目中的字典枚举
如果您有以上几个需求和痛点,或许可以尝试一下使用Torna。
本地部署了torna服务器,由于没有公网IP,如何让外网也能连接访问内网的API接口文档管理?这里提供一种简便的内网映射外网方案:nat123端口映射。只要本地内网有联网,能上网,就可以通过nat123简单操作添加保存设置,将本地内网地址转换成外网访问。下面是具体实现过程参考,不管是web场景,还是其他应用都可以参照流程教程来做。
一二三全程三个步骤,将内网torna让外网访问的实现:
1,内网访问
明确内网自己的应用本身正常,在内网可以正常访问自己的应用(如api接口管理工具等)。
并记录下内网访问时使用内网地址端口信息。
2,内网映射设置
在部署好本地的系统服务器后,可以在本地服务器上,或者所在局域网内任意内网互通计算机设备上,安装并登录nat123添加端口映射设置。通过这一步nat123软件上添加映射设置,将具体的内网地址变成外网地址。
添加映射时选择填写的信息参考:
应用类型:根据自己本地应用场景选择。属于后台管理系统web api平台不考虑收录场景的一般采用非80映射外网。
应用名称:自定义。方便区别和标志。如“web”、“torna”、“api接口”、“网站”等。
内网地址:填写上自己内网实际访问使用的地址。本机可以用127.0.0.1格式。
内网端口:填写上自己内网实际访问使用的端口号。如7001。不能随便填写,一定要填写上自己本地内网实际使用的端口号。
外网地址:自动生成可自定义免费二级域名。或填写上自己注册独立权限域名,并在自己注册域名解析商网站管理后台添加对应的cname指向让自己域名生效。
外网端口:自动生成不用改。外网访问时用到的。
添加映射设置后,保持nat123软件服务的运行状态,不要退出关闭它。如有什么问题,可以直接将鼠标停留对应输入框参考提示。
3,外网访问
内网nat123映射生效正常后,在外网访问web api时,使用映射后的外网地址(域名和外网端口)进行访问登录。
关于api接口类型:
通常本地服务器部署的接口服务包括web服务或普通TCP连接服务。web api接口跟网站服务是同种类型服务,TCP连接的跟远程桌面连接数据库是同一种类型。均可以通过nat123让外网访问内网实现。
内网映射外网访问小结:
除了外网访问本地API接口服务,个人和企业部署在内网的ERP、管理系统、后台登录站点、远程桌面、SSH远程、SVN、个人网盘、OA、ERP、NAS、https或http网站、FTP文件共享服务、管家婆、打印机、视频监控、数据库、服务器等重要办公系统和设备应用,在没有拉专线或公网IP的情况下,无法实现异地跨网访问,相关业务只能暂时中止或搁浅。其实,面对这一难题,只需在内部简单安装nat123软件就能解决,轻松实现内网地址让外网访问。
快速了解相关:
使用端口映射还是动态域名解析?>
端口映射与动态域名解析的区别?>
选择什么映射类型?
80映射与网站加速的区别?>
本地加速与网站加速的区别?>
免费与VIP的区别?>
如何选择映射VIP?
如何使用映射VIP(80网站)?>
如何使用映射VIP(非网站)?>
如何使用动态域名解析VIP服务?
如何使用自己的域名(根域名和www子域名)?>
客户端帐号能否多处登陆?
当前活动:
1.
非80映射免费VIP。
2.
80映射免费VIP全映射。
3.
非网站免费VIP全端口。
4.
充值送N币再送T币。
5.
站外分享送T币活动。
端口映射高级功能:
1.
如何切换使用映射VIP线路。
2.
http穿透解决http屏蔽问题。
3.
端口映射应用多机负载均衡。
4.
80映射网站默认使用快照提示取消。
5.
映射网站默认未登录提示页面自定义。
6.
如何设置映射网站离线转跳自定义目标地址。
7.
防火墙与访问日志(查看来访者IP和阻止IP端口)。
8.
80网快照录制和缓存删除。
9.
自主发布映射服务。
10.
自主选择网站集群线路访问端国内外区域。
动态域名解析高级功能:
1.
动态域名解析应用多机负载均衡。
2.
动态域名解析VIP怎么用。
域名解析高级功能:
1.
域名解析A记录宕机检测和故障转移。
2.
URL显性转发和隐性转发。
3.
URL转发默认提示取消。
远程开机:
1.
微信/网页远程开机。
![]() |
![]() |
![]() |