导入API

<p><a href="https://swagger.io/docs/specification/about/?spm=a2c4g.11186623.2.35.72533829dWdKTl" target="_blank">Swagger</a>是一种基于OpenAPI规范的开源工具,用于设计和描述后端服务的API。目前平安云API网关支持导入Swagger2.0标准规范的文件以快速创建API。</p> <p><span style="font-size:18px"><strong>前提条件</strong></span></p> <ol> <li>获取待导入的Swagger文件,Swagger的相关内容可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Common_Reference.Swagger.Basic_Structure" target="_blank">Swagger使用说明</a>。</li> <li>您需要在API定义中补全API网关的Swagger的扩展定义,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Common_Reference.Swagger.Swagger_Extension" target="_blank">Swagger扩展</a>。</li> <li>用户可创建的API分组数量及分组下可创建的API数量需要大于Swagger文件里包含的API分组数量及API数量。</li> </ol> <p><span style="font-size:18px"><strong>操作步骤</strong></span></p> <p>1.&nbsp; 登录<a href="https://pinganyun.com/console/apiGateway" target="_blank">API网关管理控制台</a>。</p> <p>2.&nbsp; 单击左侧导航栏<strong>开放</strong><strong>API</strong> &gt;<strong> API</strong><strong>管理</strong>,进入<strong>API</strong><strong>管理</strong>页面。</p> <p>3.&nbsp; 选择目标地域。</p> <p>4.&nbsp; 单击页面右上角的<strong>导入</strong>,进入<strong>导入</strong>页面。</p> <p>5.&nbsp; 根据以下信息,导入Swagger文件:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed; vertical-align:top"> <p><strong>说明</strong></p> </td> </tr> <tr> <td style="vertical-align:top"> <p>导入方式</p> </td> <td style="vertical-align:top"> <p>导入Swagger到分组的方式,目前支持:</p> <ul> <li><strong>导入到新的分组</strong>:系统会自动根据Swagger文件创建新的分组,并将由导入Swagger文件创建的API归属到新分组。</li> <li><strong>导入到已有分组</strong>:系统不会删除已有分组下的API,仅新增由Swagger文件创建的API到已有分组。</li> </ul> </td> </tr> <tr> <td style="vertical-align:top"> <p>API分组</p> </td> <td style="vertical-align:top"> <p>在<strong>导入方式</strong>为<strong>导入到已有分组</strong>时,需要设置此项。</p> <p>选择导入到的目标分组。</p> </td> </tr> <tr> <td style="vertical-align:top"> <p>是否覆盖</p> </td> <td style="vertical-align:top"> <p>在<strong>导入方式</strong>为<strong>导入到已有分组</strong>时,需要设置此项。</p> <p>打开<strong>覆盖</strong>开关,若待导入Swagger文件中的Path和HTTP Method与已有分组中的API重复,则由导入Swagger文件创建的API覆盖已有API。</p> </td> </tr> <tr> <td style="vertical-align:top"> <p>导入Swagger</p> </td> <td style="vertical-align:top"> <p>单击<strong>上传</strong><strong>Swagger</strong>,选择目标Swagger文件并上传。</p> </td> </tr> <tr> <td style="vertical-align:top"> <p>预检</p> </td> <td style="vertical-align:top"> <p>单击<strong>预检</strong>,对待导入的Swagger文件进行检查。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633941250"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010112736-19801e9693db.png" style="height:26px; margin:0px; width:65px" />:如果导入的Swagger文件的编码不是utf-8,可能会出现乱码。</p> </td> </tr> <tr> <td style="vertical-align:top"> <p>返回结果</p> </td> <td style="vertical-align:top"> <p>显示预检的结果。包括:</p> <p><strong>API</strong><strong>名称</strong>、<strong>PATH</strong>、<strong>分组名称</strong>、<strong>预检状态</strong>以及<strong>预检失败原因</strong>。</p> </td> </tr> </tbody> </table> <p>6.&nbsp; 单击<strong>导入</strong>。</p> <p>7.&nbsp; 单击<strong>完成</strong>。</p> <p><span style="font-size:18px"><strong>执行结果</strong></span></p> <p>在API管理页面的目标地域下,可以看到目标API已成功创建。</p>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题