使用API网关开放后端服务为HTTP/HTTPS类型的API

<p>本文主要介绍如何开放并发布后端服务为HTTP/HTTPS类型的API。</p> <p><strong>前提条件</strong></p> <p>您已成功搭建HTTP/HTTPS类型的后端服务。</p> <p><strong>创建分组</strong></p> <p>1.&nbsp; 登录<a href="https://pinganyun.com/console/apiGateway" target="_blank">API网关管理控制台</a>。</p> <p>2.&nbsp; 单击左侧导航栏<strong>开放API &gt; 分组管理</strong>,进入<strong>分组管理</strong>页面。</p> <p>3.&nbsp; 单击页面右上角<strong>创建</strong>,填写<strong>分组名称</strong>和<strong>描述</strong>。然后单击<strong>确认</strong>完成分组创建。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307142604-17ef200c9b34.png" /></p> <p><strong>创建API</strong></p> <p>1.&nbsp; 单击左侧导航栏<strong>开放API &gt; API管理</strong>,进入<strong>API管理</strong>页面。</p> <p>2.&nbsp; 单击页面右上角<strong>创建</strong>,进入<strong>创建API</strong>页面。</p> <p>3.&nbsp; 在<strong>基本信息</strong>页签,填写<strong>API名称</strong>和<strong>描述</strong>,选择刚刚创建的分组、公开类型、安全认证以及签名算法等信息。配置完成后,单击<strong>下一步</strong>。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307142757-147c1731929a.png" /></p> <p>4.&nbsp; 在<strong>定义API请求</strong>页签,设置<strong>请求PATH</strong>、<strong>匹配模式</strong>、<strong>HTTP Method</strong>等信息。若请求PATH中包含参数,则需要在<strong>入参定义</strong>区域定义参数。本例中请求PATH包含参数Number,因此在<strong>入参定义</strong>区域定义了参数Number。配置完成后,单击<strong>下一步</strong>。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307142855-10fe9e2b957f.png" /></p> <p>5.&nbsp; 在<strong>定义后端服务</strong>页签,选择<strong>后端服务类型</strong>为<strong>HTTP/HTTPS</strong>。设置<strong>HTTP Method</strong>、<strong>后端服务地址</strong>、<strong>后端请求Path</strong>、<strong>后端Socket超时</strong>等信息,详细说明可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/AccessToGuide.API_publishing.Create_API" target="_blank">创建API</a>。若后端请求Path中包含参数,则需要在<strong>后端服务参数</strong>区域定义参数。配置完成后,单击<strong>下一步</strong>。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307142935-1e2503eb9698.png" style="height:724px; width:830px" /></p> <p>6.&nbsp; 在<strong>定义返回结果</strong>页签,设置<strong>返回Content-type</strong>、<strong>成功返回结果示例</strong>以及<strong>失败返回结果示例</strong>等信息。配置完成后,单击<strong>完成</strong>。</p> <p><strong>发布API</strong></p> <p>1.&nbsp; API创建成功后,在弹出的<strong>提示信息</strong>页面,单击<strong>发布API</strong>。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143101-1a49ab219572.png" /></p> <p>2. 在<strong>发布API</strong>页面,选择<strong>release</strong>环境,填写<strong>描述</strong>信息,单击<strong>确认</strong>完成发布。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143126-170617b19109.png" style="height:31px; width:65px" />:release是默认的线上环境。您也可以根据需要自行创建环境,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.Environment_Management.Create_Environment" target="_blank">创建环境</a>。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143150-1a66760b995a.png" /></p> <p><strong>创建应用和API授权</strong></p> <p>1.&nbsp; 创建应用。</p> <p>&nbsp; &nbsp; &nbsp;a)&nbsp; 单击左侧导航栏<strong>调用API &gt; 应用管理</strong>。</p> <p>&nbsp; &nbsp; &nbsp;b)&nbsp; 在<strong>应用管理</strong>页面,单击页面右上角<strong>创建</strong>,在<strong>创建应用</strong>页面,填写<strong>应用名称</strong>和<strong>应用描述</strong>。单击<strong>确认</strong>完成创建。</p> <p><!--[if gte vml 1]><v:shape id="图片_x0020_24" o:spid="_x0000_i1030" type="#_x0000_t75" style='width:357pt; height:172.5pt;visibility:visible;mso-wrap-style:square'> <v:imagedata src="file:///D:/Users/CHENGJING534/AppData/Local/Temp/msohtmlclip1/01/clip_image014.png" o:title=""/> </v:shape><![endif]-->&nbsp; &nbsp; &nbsp;<img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143357-1c0f63e094a9.png" /></p> <p>2.&nbsp; API授权。</p> <p>&nbsp; &nbsp; &nbsp;a)&nbsp; 单击左侧导航栏<strong>开放API &gt; API管理。</strong></p> <p>&nbsp; &nbsp; &nbsp;b)&nbsp; 在<strong>API管理</strong>页面,单击目标API<strong>操作</strong>列<strong>授权</strong>。</p> <p>&nbsp; &nbsp; &nbsp;c)&nbsp; &nbsp;在<strong>授权</strong>页面,选择<strong>有效时间</strong>及<strong>授权环境</strong>,添加需要授权的应用名称。单击<strong>确认</strong>完成API授权。</p> <p>&nbsp; &nbsp; &nbsp;&nbsp;<img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143451-1be71e129de4.png" /></p> <p><strong>调试API</strong></p> <p>1.&nbsp; 单击左侧导航栏<strong>开放API &gt; API管理</strong>,进入<strong>API管理</strong>页面。</p> <p>2.&nbsp; 单击目标API<strong>操作</strong>列<img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143634-1b2530c99475.png" /><strong>&gt; 调试</strong>,进入<strong>API调试</strong>页面。</p> <p>3.&nbsp; 在<strong>调试面板</strong>区域页面,选择<strong>发布环境</strong>和<strong>应用</strong>。若请求PATH中包含了参数,需要填入参数值,本例中需要填入参数Number的值。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307143709-128af15a904c.png" /></p> <p>4.&nbsp; 单击<strong>发送请求</strong>,在<strong>返回结果</strong>区域即可查看返回结果。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307144644-15350d009948.png" /></p> <p><strong>调用API</strong></p> <p>单击左侧导航栏<strong>调用API &gt; </strong><strong>SDK/</strong><strong>文档下载</strong>,在<strong>SDK/</strong><strong>文档下载</strong>页面下载目标应用的SDK,根据Readme.md文件的提示,调用API服务。</p> <p><img src="https://obs-cn-shanghai.fincloud.pinganyun.com/pacloud/20202307144709-1bf7a1609073.png" /></p>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题