计算机业内人士对于swagger并不陌生, 不少人选择用swagger做为API接口文档管理。Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
swagger主要有两个作用,一是 接口的文档在线自动生成,二是功能测试。Swagger让部署管理和使用功能强大的 API 变得简单化。
那么,本地无公网IP主机上搭建部署的swagger文档管理服务器,如何发布让外网也能访问呢?这里介绍一种简单的内网映射外网方案:快解析端口映射。只要可以本地有联网,就可以通过快解析一步添加操作,将本地内网swagger访问地址提供到外网访问。以下是实现步骤,供大家参考。
第一步:在内网部署swagger及测试访问
本地计算机部署好后,除了本机能访问外,局域网内其他电脑设备也要测试访问状态。
第二步:一步设置内网映射外网
在API接口服务器本地,或者所在内网另台主机电脑上,安装并登录快解析客户端,添加一个端口映射记录。通过这一步操作,将内网地址变成外网地址。
映射时,根据自己应用场景填写正确的映射信息:
映射名称:自定义。方便区别和标志。如“api”、“接口”、“web"、"swagger"等。
公网类型:指外网访问所用的端口。办公项目、后台管理、信息管理、运营管理等不收录项目站点服务一般采用非80映射外网。
内网ip地址:填写上自己内网访问swagger管理web实际访问使用的地址。本机可以用127.0.0.1格式。
应用程序端口:填写上自己内网swagger访问管理web实际访问使用的端口号。如7001。不能随便填写,一定要填写上自己本地内网实际使用的端口号。
填写完成后点击确定,自动生成免费自定义二级域名,或填写上自己的域名,同时在自己域名注册解析商网站后台,添加对应一个cname指向,让自己域名生效。
第三步:外网访问swagger
快解析映射生效正常后,在外网访问内网的API文档管理web时,使用映射后的外网地址(域名和外网端口)进行访问。
内网API让外网访问的全程完成。本地搭建的API服务器,提供发布到外网访问测试调试,跨网访问接口程序等,通过快解析外网方式,简单方便就可以实现。
个人和企业在内网部署的ERP、远程桌面、SSH远程、SVN、个人网盘、OA、ERP、NAS、https或http网站、FTP文件共享服务、管家婆、打印机、视频监控、数据库、服务器等重要办公系统和设备应用,在没有拉专线或公网IP的情况下,无法实现异地跨网访问,相业务只能暂时中止或搁浅。其实,面对这一难题,只需在内部简单安装快解析软件就能解决,轻松实现内网地址让外网访问。