首页 > 其他分享 >内网部署api接口文档服务器端口如何让外网访问?

内网部署api接口文档服务器端口如何让外网访问?

时间:2024-06-03 12:02:55浏览次数:30  
标签:API 服务器端 映射 访问 外网 api swagger 内网

计算机业内人士对于swagger并不陌生, 不少人选择用swagger做为API接口文档管理。Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。

内网部署api接口文档服务器端口如何让外网访问?

swagger主要有两个作用,一是接口的文档在线自动生成,二是功能测试。Swagger让部署管理和使用功能强大的 API 变得简单化。

那么,本地无公网IP主机上搭建部署的swagger文档管理服务器,如何发布让外网也能访问呢?这里介绍一种简单的内网映射外网方案:快解析端口映射。只要本地有联网,就可以通过快解析一步添加操作,将本地内网swagger访问地址提供到外网访问。以下是实现步骤,供大家参考。

第一步:在内网部署swagger及测试访问

本地计算机部署好后,除了本机能访问外,局域网内其他电脑设备也要测试访问状态。

第二步:快解析一步设置内网映射外网    

在API接口服务器本地,或者所在内网另台主机电脑上,安装并登录快解析客户端,添加一个端口映射记录。通过这一步操作,将内网地址变成外网地址。

映射时,根据自己应用场景填写正确的映射信息:

内网部署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的情况下,无法实现异地跨网访问,面对这一难题,只需在内部简单安装快解析软件就能解决,轻松实现内网地址让外网访问。

标签:API,服务器端,映射,访问,外网,api,swagger,内网
From: https://blog.csdn.net/wat0612/article/details/139411026

相关文章

  • 淘宝商品id怎么实现批量自动获取?通过关键字搜索接口来获取批量商品id(淘宝API)
    item_search-按关键字搜索淘宝商品传入商品关键字,通常在商品标题中进行检索,将包含此关键字的商品展示出来,分页展示。公共参数名称类型必须描述keyString是调用key(必须以GET方式拼接在URL中)secretString是调用密钥api_nameString是API接口名称(包括在请求地址中)[item_search,i......
  • python对接zabbix API
    frompyzabbix.apiimportZabbixAPIwithZabbixAPI(url='http://192.168.1.10:8080',user='admin',password='admin')aszapi:hosts=zapi.host.get(#获取所有字段output=["hostid","host"],......
  • 如何使用Node.js、TypeScript和Express实现RESTful API服务
    Node.js是一个基于ChromeV8引擎的JavaScript运行环境。Node.js使用了一个事件驱动、非阻塞式I/O的模型,使其轻量又高效。Express是一个保持最小规模的灵活的Node.jsWeb应用程序开发框架,为Web和移动应用程序提供一组强大的功能。使用Node.js和Express可以快速的实现一个......
  • 基于OpenAI API接口向GPT4v上传图像进行图像分析
    importopenaiimportbase64fromopenaiimportOpenAIclient=OpenAI(api_key='xxxxxxxxx',base_url='https://api.openai.com/v1'#可根据镜像站修改)#图片转base64函数defencode_image(image_path):withopen(image_path,"rb")......
  • JSAPI:DOM操作
    DOM操作WebAPIAPI:预定好的函数例如:alert(),console.log(),prompt()WebAPI:浏览器提供的一套操作浏览器功能和页面元素的API(BOM,DOM),DOM的顶级对象是documentBOM的顶级对象是window节点:页面中的所有内容都是节点(标签,属性,注释,文本)获取元素的方法document.getElementBy......
  • webapi 配置接口注释显示
    1.再Program.cs文件中添加builder.Services.AddSwaggerGen(options=>{//读取根据api生成的控制器xml文件varfile=Path.Combine(AppContext.BaseDirectory,"WebApplication1.Webapi.xml");//显示控制器层注释options.IncludeXmlComments(file,true)......
  • fastapi 实现HTTP访问
    1.概述在使用python时,我如何发布一个接口给外部访问,python有FASTAPI和uvicorn实现,fastapi是定义api接口,uvicorn运行服务器。2.安装依赖pipinstallfastapipipinstallpydanticpipinstalluvicorn3.定义接口3.1快速上手fromfastapiimportFastAPI,Body,......
  • SpringBoot基于OpenAPI3的接口文档管理快速集成和使用
    你好,这里是codetrend专栏“SpringCloud2023实战”。本文主要简单介绍SpringCloud2023中进行接口文档管理,方便前后端开发和文档维护。文档管理工具基于开源的knife4j封装的openapi3。前言OpenAPI3.0(前身为Swagger)是一种RESTfulAPI文档规范。OpenAPI3.0规范是一种易于阅读和理......
  • 【swagger】@ApiImplicitParam注解Integer类型required=true时不能提交、@ApiImplicit
    文章目录一、问题描述二、问题原因三、解决方法3.1、修改dataType=int3.2、修改dataType=Long3.3、修改dataType类型为String类型3.4、当dataType类型为Integer时,删除required=true以下内容基于swagger2.9.2进行讲解<!--swagger2--><dependency> <groupId>io.sp......
  • 【Web API DOM02】如何获取、操作DOM元素
    一:获取DOM元素1根据CSS选择器获取语法格式如下:(1)选中一个DOM元素document.querySeletor('CSS选择器')<ul><li>1</li><li>2</li><li>3</li></ul>document.querySelector('li')//只能获取第一个li该选择器只能选中第一个DOM元......