企业接口文档解决方案,目标是让文档管理变得更加方便、快捷。Torna采用团队协作的方式管理和维护项目API文档,将不同形式的文档纳入进来,形成一个统一的维护方式。下面简单给大家介绍一下torna接口文档管理工具都有哪些功能特性:
1.文档管理。支持接口文档增删改查、导入导出、OpenAPI接入、字典管理、接口调试。
2.权限管理。以项目组的形式管理接口,各项目组之间接口互不影响,同时有访客、开发者、管理员三种角色,每种角色有用不同权限。
3.双模式。提供【管理模式】、【浏览模式】双模式,管理模式用来编辑文档内容,浏览模式纯粹查阅文档,界面无其它元素干扰。
Torna弥补了传统文档生成工具(如swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。通过torna接口文档解决方案可以解决以下文档管理痛点:
不满足swagger文档预览页面和调试页面的展现方式;不喜欢swagger这种侵入式注解; 希望使用javadoc注释生成文档,并进行接口调试; 希望把公司所有项目接口文档进行统一管理; 希望把项目中的若干文档提供给第三方调用者查看;希望可以统一管理项目中的字典枚举。
如果您有以上几个需求和痛点,或许可以尝试一下使用Torna。那么如何将本地内网api或web或应用利用快解析让外网访问的实现呢?
本地部署了torna服务器,由于没有公网IP,如何让外网也能连接访问内网的API接口文档管理?这里提供一种简便的内网映射外网方案:快解析端口映射。只要本地内网有联网,能上网,就可以通过快解析简单操作添加保存设置,将本地内网地址转换成外网访问。下面是具体实现过程参考,不管是web场景,还是其他应用都可以参照流程教程来做。全程三个步骤,将内网torna让外网访问的实现:
第一步:内网访问
明确内网自己的应用本身正常,在内网可以正常访问自己的应用,如api接口管理工具等,并记录下内网访问时使用内网地址端口信息。
第二步:内网映射设置
在部署好本地的系统服务器后,可以在本地服务器上,或者所在局域网内任意内网互通计算机设备上,安装并登录快解析添加端口映射设置。通过这一步快解析软件上添加映射设置,将具体的内网地址变成外网地址。
添加映射时选择填写的信息参考:
映射名称:自定义。方便区别和标志,如“web”、“torna”、“api接口”、“网站”等。
公网类型:指外网访问所用的端口。办公项目、后台管理、信息管理、运营管理等不收录项目站点服务一般采用非80映射外网。
内网ip地址:内网访问固定地址。可以是固定内网IP或计算机名。如是在内网服务器本机使用映射的,推荐填写127.0.0.1格式。如果使用了内网IP格式的,注意需要确保这个IP是固定不变的避免IP变化影响。
应用程序端口:内网web网站访问端口
第三步:外网访问
填写完成后点击确定。内网快解析映射生效正常后,在外网访问web api时,使用映射后的外网地址(域名和外网端口)进行访问登录。
通常本地服务器部署的接口服务包括web服务或普通TCP连接服务。web api接口跟网站服务是同种类型服务,TCP连接的跟远程桌面连接数据库是同一种类型,均可以通过快解析让外网访问内网实现。
除了外网访问本地API接口服务,个人和企业部署在内网的ERP、管理系统、后台登录站点、远程桌面、SSH远程、SVN、个人网盘、OA、ERP、NAS、https或http网站、FTP文件共享服务、管家婆、打印机、视频监控、数据库、服务器等重要办公系统和设备应用,在没有拉专线或公网IP的情况下,都可以通过在内部简单安装快解析软件就能解决,轻松实现内网地址让外网访问。