创建API

<p>本文主要介绍如何创建API。&nbsp;</p> <p><span style="font-size:18px"><strong>前提条件</strong></span></p> <p>1.&nbsp; 您已成功创建API分组,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.Group_Management.Create_Group" target="_blank">创建分组</a>。</p> <p>2.&nbsp; 若定义API请求的<strong>后端服务类型</strong>选择<strong>VPC</strong><strong>通道</strong>,请先创建VPC通道,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.VPC_Connection.Create_VPC_Connection" target="_blank">创建VPC通道</a>。</p> <p><span style="font-size:18px"><strong>注意事项</strong></span></p> <p>每个分组最多可创建100个API。</p> <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><strong>API</strong>页面。</p> <p><span style="font-size:16px"><strong>基本信息</strong></span></p> <p>1.&nbsp; 填写创建API的基本信息:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>API名称</p> </td> <td> <p>API的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633875910"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:</p> <p>1.&nbsp; API名称在当前主账户的每个地域下必须唯一。</p> <p>2.&nbsp; API名称的长度为2~50个字符。</p> <p>3.&nbsp; 可包含汉字、英文、下划线_、或数字。</p> <p>4.&nbsp; 需要以英文或汉字开始。</p> </td> </tr> <tr> <td> <p>所属分组</p> </td> <td> <p>选择已成功创建的分组。</p> </td> </tr> <tr> <td> <p>类型</p> </td> <td> <p>API的类型,目前支持:</p> <p>&bull;&nbsp; 公开:在release环境发布的API,可以发布到云市场。</p> <p>&bull;&nbsp; 私有:不会发布到云市场。如果用户调用私有类型的API,需要进行授权。</p> </td> </tr> <tr> <td> <p>安全认证</p> </td> <td> <p>调用API的认证方式,确保调用方发送给API网关的API请求的安全性,目前支持:</p> <p>&bull;&nbsp; APP认证:调用API时,由平安云API网关服务负责对应用进行安全认证。</p> <p>&bull;&nbsp; 无认证:不需要认证。任何可以获取此API的应用,均可以调用。</p> </td> </tr> <tr> <td> <p>签名算法</p> </td> <td> <p>在<strong>安全认证</strong>为<strong>APP</strong><strong>认证</strong>时,需要设置此项。目前支持:</p> <p>&bull;&nbsp; HmacSHA1</p> <p>&bull;&nbsp; HmacSHA256</p> </td> </tr> <tr> <td> <p>描述</p> </td> <td> <p>API的描述信息。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1026" DrawAspect="Content" ObjectID="_1633875911"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:描述信息长度为1~200个字符。</p> </td> </tr> </tbody> </table> <p>2.&nbsp; 单击<strong>下一步</strong>。</p> <p><span style="font-size:16px"><strong>定义API请求</strong></span></p> <p>1.&nbsp; 根据以下信息,定义API请求的相关信息:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>请求PATH</p> </td> <td> <p>API的请求路径,例如:/getUserInfo/{userId}。</p> <p>如果请求Path中包含参数:</p> <p>&bull;&nbsp; 请用{ }标识参数,参数区分大小写。</p> <p>&bull;&nbsp; 需要对参数进行定义,可参考<a href="#id_01" target="_blank"><strong>入参定义</strong></a>。</p> </td> </tr> <tr> <td> <p>匹配模式</p> </td> <td> <p>API请求路径的匹配模式,目前支持:</p> <p><strong>&bull;&nbsp; 完整路径匹配</strong>:调用的请求路径需要与<strong>请求</strong><strong>PATH</strong>完全一致。</p> <p><strong>&bull;&nbsp; 前缀路径匹配</strong>:调用的请求路径以<strong>请求</strong><strong>PATH</strong>为前缀<strong>。</strong></p> <p>例如:定义API请求时设置的<strong>请求</strong><strong>PATH</strong>是/getUserInfo/test,使用前缀路径匹配时,可通过/getUserInfo/test/AAA访问,但不可通过/getUserInfo/testAAA访问。</p> </td> </tr> <tr> <td> <p>HTTP Method</p> </td> <td> <p>接口的调用方式,目前支持:GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY</p> </td> </tr> <tr> <td> <p>支持跨域</p> </td> <td> <p>是否开启跨域(CORS:Cross-Origin Resource Sharing),可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Common_Reference.CORS.Classify" target="_blank">跨域资源共享(CORS)</a>。</p> <p>默认情况下不开启跨域。</p> </td> </tr> <tr> <td> <p>入参定义</p> </td> <td> <p>若请求路径中包含参数,需要对该参数进行详细定义。</p> <p>在<strong>入参定义</strong>区域,单击<strong>添加</strong>,进入<strong>添加入参定义</strong>页面<a href="#id_01" target="_blank">添加入参定义</a>。</p> </td> </tr> <tr> <td> <p>请求体内容描述</p> </td> <td> <p>请求体的相关描述。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876055"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:</p> <p>1.&nbsp; 在<strong>HTTP Method</strong>是<strong>POST</strong>、<strong>PUT</strong>、<strong>PATCH</strong>或<strong>ANY</strong>时,此项可填。</p> <p>2.&nbsp; 描述信息长度为0~512个字符。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_01" name="id_01"><strong>入参定义</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>参数名</p> </td> <td> <p>参数的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876193"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:参数的名称需要与<strong>请</strong><strong>PATH</strong>中设置的参数名称一致。</p> </td> </tr> <tr> <td> <p>参数位置</p> </td> <td> <p>参数在请求路径中的位置,目前支持:PATH、QUERY、HEADER。</p> </td> </tr> <tr> <td> <p>类型</p> </td> <td> <p>参数字段的数据类型,目前支持:String、Int、Long、Float、Double、Boolean。</p> </td> </tr> <tr> <td> <p>是否必填</p> </td> <td> <p>调用API时,此参数是否必须填写。</p> <p>如果必填,API网关在将校验API请求是否包含此参数,如果检测没有此参数,则拒绝该请求。</p> <p>参数位置是:</p> <p>&bull;&nbsp; PATH时,默认必填,不可修改。</p> <p>&bull;&nbsp;&nbsp;QUERY时,默认必填,可修改。</p> <p>&bull;&nbsp;&nbsp;HEADER时,默认必填,可修改。</p> </td> </tr> <tr> <td> <p>默认值</p> </td> <td> <p><strong>是否必填</strong>选择<strong>否</strong>时,此项可设置。</p> <p>在API请求不包含此参数时,API网关将自动为该参数增加设置的默认值发送给后端服务。</p> </td> </tr> <tr> <td> <p>示例</p> </td> <td> <p>(可选)填写参数值的示例。</p> </td> </tr> <tr> <td> <p>描述</p> </td> <td> <p>(可选)对此参数的说明。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1026" DrawAspect="Content" ObjectID="_1633876194"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:描述信息长度为0~200个字符。</p> </td> </tr> </tbody> </table> <p>2.&nbsp; 单击<strong>下一步</strong>。</p> <p><span style="font-size:16px"><strong>定义后端服务</strong></span></p> <p>定义后端服务主要是定义API网关控制台前端和后端服务的映射,用户请求到达API网关后,API网关会根据您的后端服务配置,将API请求发送给后端服务。</p> <p>后端服务类型包括:</p> <ul> <li>HTTP/HTTPS:若您的服务使用的是HTTP/HTTPS协议,可选择此项。</li> <li>VPC通道(仅新加坡地域支持):可将您部署在平安云VPC中的应用发布成API,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.VPC_Connection.Create_VPC_Connection" target="_blank">创建VPC通道</a>。</li> <li>MOCK:Mock方式主要用于API的调试环境,提前设置返回结果,在测试环境下调用API时,不调用后端服务,直接返回设置的结果给API调用方。</li> </ul> <p>1.&nbsp; 根据以下信息,定义后端服务:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>后端服务类型</strong></p> </td> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td rowspan="7"> <p>HTTP/HTTTPS</p> </td> <td> <p>HTTP Method</p> </td> <td> <p>接口的调用方式,目前支持:GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY。</p> </td> </tr> <tr> <td> <p>后端服务地址</p> </td> <td> <p>后端服务的地址,格式:http(s)://host:port。</p> <p>例如:http://10.0.0.1或http://autotest.com.cn</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876336"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:</p> <p>&bull; host:后端服务的IP地址或访问域名。</p> <p>&bull;&nbsp; (可选)port:后端服务的访问端口。</p> <p>&bull;&nbsp; 后端服务地址支持环境变量,需用[ ]标识,例如:http://api.[url].com,环境变量可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.Group_Management.Environment_Variable" target="_blank">添加环境变量</a>。</p> </td> </tr> <tr> <td> <p>后端请求Path</p> </td> <td> <p>后端服务的请求路径。</p> <p>一个API中的<strong>请求</strong><strong>PATH</strong>对应一个<strong>后端服务请求</strong><strong>Path</strong>。</p> <p>&bull;&nbsp; 可包含参数,用{ }标识。同时需要对参数进行定义,可参考<strong>后端服务参数</strong>。</p> <p>&bull;&nbsp; 可包含环境变量,用[ ]标识,例如:http://api.[url].com,环境变量可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.Group_Management.Environment_Variable" target="_blank">添加环境变量</a>。</p> </td> </tr> <tr> <td> <p>后端Socket超时</p> </td> <td> <p>后端服务请求超时的时间,超过设定值后,API网关不再等待后端服务的响应,同时返回相应的错误信息到API调用方。取值范围是1~60000ms,默认情况是5000ms。</p> </td> </tr> <tr> <td> <p>后端服务参数</p> </td> <td> <p>如果<strong>后端请求</strong><strong>Path</strong>中包含参数,需要对该参数进行详细定义。</p> <p>在<strong>后端服务参数</strong>区域,单击<strong>添加</strong>,进入<strong>添加后端参数映射</strong>页面添加相关参数,可参考<a href="#id_02" target="_blank">添加后端服务参数</a>。</p> </td> </tr> <tr> <td> <p>常量参数</p> </td> <td> <p>常量参数对用户不可见,如果配置了常量参数,API网关会在转发API请求时,将常量参数加入到请求中的指定位置,传递至后端服务,从而实现后端的业务需求,可参考<a href="#id_03" target="_blank">添加常量参数</a>。</p> </td> </tr> <tr> <td> <p>系统参数</p> </td> <td> <p>系统参数对用户不可见,如果配置了系统参数,API网关会将系统参数加入到请求中的指定位置,传递至后端服务,从而实现后端的业务需求,可参考<a href="#id_04" target="_blank">添加系统参数</a>。</p> </td> </tr> <tr> <td rowspan="7"> <p>VPC通道(仅新加坡地域支持)</p> </td> <td> <p>HTTP Method</p> </td> <td> <p>接口的调用方式,目前支持:GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY。</p> </td> </tr> <tr> <td> <p>VPC通道</p> </td> <td> <p>选择已经创建的VPC通道,可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.VPC_Connection.Create_VPC_Connection" target="_blank">创建VPC通道</a>。</p> </td> </tr> <tr> <td> <p>后端请求Path</p> </td> <td> <p>后端服务的请求路径。</p> <p>一个API中的<strong>请求</strong><strong>PATH</strong>对应一个<strong>后端服务请求</strong><strong>Path</strong>。</p> <p>&bull;&nbsp; 可包含参数,用{ }标识。同时需要对参数进行定义,可参考<strong>后端服务参数</strong>。</p> <p>&bull;&nbsp; 可包含环境变量,用[ ]标识,例如:http://api.[url].com,环境变量可参考<a href="https://pinganyun.com/ssr/help/middleware/APIGateway/Instance_Management.Publishing_API.Group_Management.Environment_Variable" target="_blank">添加环境变量</a>。</p> </td> </tr> <tr> <td> <p>后端超时Socket超时</p> </td> <td> <p>后端服务请求超时的时间,超过设定值后,API网关不再等待后端服务的响应,同时返回相应的错误信息给API调用方。取值范围是1~60000ms,默认情况是5000ms。</p> </td> </tr> <tr> <td> <p>后端服务参数</p> </td> <td> <p>若<strong>后端请求</strong><strong>Path</strong>中包含参数,需要对该参数进行详细定义。</p> <p>在<strong>后端服务参数</strong>区域,单击<strong>添加</strong>,进入<strong>添加后端参数映射</strong>页面添加相关参数,可参考<a href="#id_02" target="_blank">添加后端服务参数</a>。</p> </td> </tr> <tr> <td> <p>常量参数</p> </td> <td> <p>常量参数对用户不可见,但API网关会在转发请求时,将常量参数加入到请求中的指定位置,传递至后端服务,从而实现后端的业务需求,可参考<a href="#id_03" target="_blank">添加常量参数</a>。</p> </td> </tr> <tr> <td> <p>系统参数</p> </td> <td> <p>系统参数对用户不可见,如果后端服务需要接收系统参数,则API网关会将系统参数加入到请求中的指定位置,传递至后端服务,从而实现后端的业务需求,可参考<a href="#id_04" target="_blank">添加系统参数</a>。</p> </td> </tr> <tr> <td rowspan="2"> <p>Mock</p> </td> <td> <p>Mock返回结果</p> </td> <td> <p>以Mock方式调用API返回的结果。</p> </td> </tr> <tr> <td> <p>Mock响应头</p> </td> <td> <p>定义Mock响应头的参数名和参数值,用于请求后端服务。</p> <p>在<strong>Mock</strong><strong>响应头</strong>区域,单击<strong>添加</strong>,进入<strong>添加</strong><strong>Mock</strong><strong>响应头</strong>页面添加Mock响应头的相关信息,可参考<a href="#id_05" target="_blank">添加Mock响应头</a>。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_02" name="id_02"><strong>后端服务参数</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>入参名称</p> </td> <td> <p>选择入参的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876474"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:此处的入参是<strong>请求</strong><strong>PATH</strong>中设置的参数。</p> </td> </tr> <tr> <td> <p>入参位置</p> </td> <td> <p>入参的位置。</p> <p>默认是<strong>请求</strong><strong>PATH</strong>中入参的位置,不可修改。</p> </td> </tr> <tr> <td> <p>入参类型</p> </td> <td> <p>入参字段的数据类型。</p> <p>默认是<strong>请求</strong><strong>PATH</strong>中入参的类型保持,不可修改。</p> </td> </tr> <tr> <td> <p>后端参数位置</p> </td> <td> <p>后端参数的位置,目前支持:PATH、QUERY及HEADER。</p> </td> </tr> <tr> <td> <p>后端参数名称</p> </td> <td> <p>后端参数的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1026" DrawAspect="Content" ObjectID="_1633876475"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:参数名称需要与<strong>后端请求</strong><strong>Path</strong>中设置的参数名称一致。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_03" name="id_03"><strong>常量参数</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>参数名</p> </td> <td> <p>常量参数的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876509"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:</p> <p>&bull;&nbsp; 常量参数的名称长度为1~50个字符。</p> <p>&bull;&nbsp; 可包含英文字母和数字。</p> <p>&bull;&nbsp; 首字符必须是英文字母。</p> </td> </tr> <tr> <td> <p>参数位置</p> </td> <td> <p>常量参数的位置,目前支持:PATH、QUERY及HEADER。</p> </td> </tr> <tr> <td> <p>参数值</p> </td> <td> <p>常量参数的取值。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1026" DrawAspect="Content" ObjectID="_1633876510"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:支持大小写字母、数字以及特殊字符(-._~!$&amp;&#39;()*+,;=:@)。</p> </td> </tr> <tr> <td> <p>描述</p> </td> <td> <p>常量参数的描述信息。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1027" DrawAspect="Content" ObjectID="_1633876511"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:描述信息长度为0~200个字符。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_04" name="id_04"><strong>系统参数</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>参数名</p> </td> <td> <p>选择目标系统参数。</p> </td> </tr> <tr> <td> <p>参数说明</p> </td> <td> <p>对所选系统参数的解释。</p> </td> </tr> <tr> <td> <p>参数位置</p> </td> <td> <p>系统参数的位置,目前支持:PATH、QUERY及HEADER。</p> </td> </tr> <tr> <td> <p>后端参数名称</p> </td> <td> <p>后端参数的名称,与系统参数名称进行映射。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876561"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20192910173558-17d8d04f9e75.png" style="height:26px; margin:0px; width:65px" />:</p> <p>&bull;&nbsp; 系统参数的名称长度为1~50个字符。</p> <p>&bull;&nbsp; 可包含英文字母和数字。</p> <p>&bull;&nbsp; 首字符必须是英文字母。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_05" name="id_05"><strong>Mock响应头</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; width:57px"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed; width:730px"> <p><strong>说明</strong></p> </td> </tr> <tr> <td style="width:57px"> <p>参数名</p> </td> <td style="width:730px"> <p>Mock响应头的参数名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1026" DrawAspect="Content" ObjectID="_1633876562"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104134-169a4a6d94c9.png" style="height:26px; margin:0px; width:65px" />:支持英文字母(区分大小写)、数字、特殊字符(!#$%&amp;&#39;*+-.^_`|~)。</p> </td> </tr> <tr> <td style="width:57px"> <p>参数值</p> </td> <td style="width:730px"> <p>Mock响应头的参数取值。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1027" DrawAspect="Content" ObjectID="_1633876563"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104134-169a4a6d94c9.png" style="height:26px; margin:0px; width:65px" />:支持ASCII中所有可见字符(\x21~\x7E),中间字符支持空格(SP)或者水平制表符(HTAB)。</p> </td> </tr> </tbody> </table> <p>2.&nbsp; 单击<strong>下一步</strong>。</p> <p><span style="font-size:16px"><strong>定义返回结果</strong></span></p> <p>1.&nbsp; 根据以下信息,定义返回结果:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>返回Content-type</p> </td> <td> <p>选择返回结果的内容类型。目前支持:</p> <ul> <li>application/json;charset=utf-8:JSON格式。</li> <li>text/plain;charset=utf-8:纯文本格式。</li> <li>application/octet-stream;charset=utf-8:二进制流格式。</li> <li>application/xml;charset=utf-8:XML解析格式。</li> <li>text/html;charset=utf-8:HTML解析格式。</li> <li>passthrough:透传Content-type。</li> </ul> </td> </tr> <tr> <td> <p>成功返回结果示例</p> </td> <td> <p>调用API成功,返回的响应结果。</p> </td> </tr> <tr> <td> <p>失败返回结果示例</p> </td> <td> <p>调用API失败,返回的响应结果。</p> </td> </tr> <tr> <td> <p>错误码定义</p> </td> <td> <p>可根据业务的实际情况设置错误代码,作为排查报错信息的索引。</p> <p>在<strong>错误码定义</strong>区域,单击<strong>添加</strong>,进入<strong>添加错误码</strong>页面添加错误码的相关信息,可参考<a href="#id_06" target="_blank">添加错误码</a>。</p> </td> </tr> </tbody> </table> <p>根据以下信息,添加<a id="id_06" name="id_06"><strong>错误码</strong></a>,并单击<strong>确认</strong>:</p> <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed"> <p><strong>配置项</strong></p> </td> <td style="background-color:#ededed"> <p><strong>说明</strong></p> </td> </tr> <tr> <td> <p>错误码</p> </td> <td> <p>错误码的名称。</p> <p><!--[if gte mso 9]><xml> <o:OLEObject Type="Embed" ProgID="PBrush" ShapeID="_x0000_i1025" DrawAspect="Content" ObjectID="_1633876954"> </o:OLEObject> </xml><![endif]--><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104134-169a4a6d94c9.png" style="height:26px; margin:0px; width:65px" />:</p> <ul> <li>名称的长多为1~50个字符。</li> <li>可包含英文、数字、中划线-、英文点.及下划线_。</li> </ul> </td> </tr> <tr> <td> <p>错误信息</p> </td> <td> <p>错误的详细信息。</p> <p><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104134-169a4a6d94c9.png" style="height:26px; margin:0px; width:65px" />:描述信息的长度为1~50个字符。</p> </td> </tr> <tr> <td> <p>描述</p> </td> <td> <p>错误码的描述信息。</p> <p><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104134-169a4a6d94c9.png" style="height:26px; margin:0px; width:65px" />:描述信息的长度为0~200个字符。</p> </td> </tr> </tbody> </table> <p>2.&nbsp; 单击<strong>完成</strong>。</p> <p><span style="font-size:18px"><strong>执行结果</strong></span></p> <p>系统打印提示信息。</p> <p><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104124-1caffbb2997c.png" style="height:221px; width:524px" /></p> <ul> <li>单击<strong>发布</strong><strong>API</strong>,进入<strong>发布</strong><strong>API</strong>页面,进行API发布的配置,可参考发布API。</li> <li>单击<strong>API</strong><strong>详情</strong>,进入<strong>API</strong><strong>详情</strong>页面,查看API的详细信息,可参考查看API。</li> <li>单击<strong>确认</strong>,可在<strong>API</strong><strong>管理</strong>页面的目标地域下,看到刚刚创建的API。</li> </ul> <p><img src="https://obs-cn-shanghai.yun.pingan.com/pcp-portal/20193010104107-13393777983d.png" style="height:54px; width:830px" /></p> <p><span style="font-size:18px"><strong>后续操作</strong></span></p> <p>在<strong>API管理</strong>页面的目标地域下,单击目标API<strong>操作</strong>列的<strong>编辑</strong>,进入<strong>编辑</strong><strong>API</strong>页面,可对API的配置信息进行修改。&nbsp;</p>
以上内容是否解决了您的问题?
请补全提交信息!
咨询·建议

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题