平安云 - 云以致用智造未来

Swagger扩展

• 1  x-any-method：Any接受所有请求类型 含义：<a href="https://swagger.io/specification/v2/#pathsObject" target="_blank">Paths Object</a> 属性扩展，表示该API接受所有HTTP请求类型。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   paths:     '/path':     x-any-method: Any   ... ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td style="vertical-align:top"> x-any-method </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> String </td> <td style="vertical-align:top"> 在取值为Any时，表示可接受的API请求类型。 </td> </tr> </tbody> </table> • 2  x-request-type：API请求类型 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，表示该API是否可以上架到云市场。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-request-type: PRIVATE ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td style="vertical-align:top"> x-request-type </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> String </td> <td style="vertical-align:top"> API的请求类型，该API是否可以上架云市场，目前支持： <ul> <li>PRIVITE：私有型，不上架云市场。</li> <li>PUBLIC：公有型，上架云市场。</li> </ul> </td> </tr> </tbody> </table>  • 3  x-auth-type：安全认证类型 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，表示该API在平安云网关安全认证类型。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top">    ...    paths:      '/path':        get:          x-auth-type: APP_AUTH    ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td style="vertical-align:top"> x-auth-type </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> String </td> <td> API网关的安全认证类型，目前支持： <ul> <li>APP_AUTH：调用API时，由平安云API网关服务负责对应用进行安全认证。</li> <li>NO_AUTH：不需要认证。任何可以获取此API的应用，均可以调用。</li> </ul> </td> </tr> </tbody> </table> • 4   x-signature-algorithm：签名算法 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，表示该API所使用的签名算法，当安全认证类型为APP_AUTH时需要设置该属性。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-signature-algorithm: H_MAC_SHA1 ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td style="vertical-align:top"> x-signature-algorithm </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> String </td> <td> API网关支持的签名算法： <ul> <li>H_MAC_SHA1</li> <li>H_MAC_SHA256</li> </ul> </td> </tr> </tbody> </table> • 5  x-path-match-type：匹配模式 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，表示该API的路径匹配模式。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-path-match-type: PREFIX ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-path-match-type </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> String </td> <td> 请求路径的匹配模式，目前支持： •   NORMAL：完整路径匹配，调用的请求路径需要与创建API时设置的请求PATH完全一致。 •   PREFIX：前缀路径匹配，调用的请求路径以创建API时设置的请求PATH为前缀。     例如：/getUserInfo/test/AAA或/getUserInfo/test/BBB均可匹配到/getUserInfo/test，但不会匹配/getUserInfotest。 </td> </tr> </tbody> </table> • 6  x-request-cors：跨域 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，表示该API是否支持跨域。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':      get:        x-request-cors: true ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-request-cors </td> <td style="vertical-align:top"> 否 </td> <td style="vertical-align:top"> String </td> <td> 是否支持跨域，默认情况是false： •   true：支持跨域 •   false：不支持跨域 </td> </tr> </tbody> </table> • 7  x-body-desc：请求体描述 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，用于描述API请求体内容。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':      post:        x-body-desc: The description of request body ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-body-desc </td> <td style="vertical-align:top"> 否 </td> <td style="vertical-align:top"> String </td> <td> 请求体描述。 请求方法可以是POST、PUT、PATCH、ANY等。 </td> </tr> </tbody> </table>  • 8  <a name="id_01">x-example</a>：入参定义示例 含义：<a href="https://swagger.io/specification/v2/#parameterObject" target="_blank">Parameter Object</a> 属性扩展，用于描述API请求参数的示例。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':      get:        parameters:          - {description: request param in header, in: header, name: reqHeader, required: false,          default: pingan, type: string, x-example: apigateway} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> description </td> <td> 否 </td> <td> string </td> <td> 参数的相关描述信息。 </td> </tr> <tr> <td> name </td> <td> 是 </td> <td> string </td> <td> 参数的名称。 </td> </tr> <tr> <td> in </td> <td> 是 </td> <td> string </td> <td> 参数的位置，支持：path、query、header。 </td> </tr> <tr> <td> type </td> <td> 是 </td> <td> string </td> <td> 参数的属性值类型，支持：string、integer、number、boolean。 </td> </tr> <tr> <td> required </td> <td> 是 </td> <td> string </td> <td> 参数的属性值是否必填： •  true：必填 •  false：可选 </td> </tr> <tr> <td> default </td> <td> 否 </td> <td> string </td> <td> 参数属性值的默认情况，当required为true时需要设置。 </td> </tr> <tr> <td> x-example </td> <td> 否 </td> <td> string </td> <td> 参数的属性值示例。 </td> </tr> </tbody> </table> • 9  x-backend-parameters：后端服务参数 含义：<a href="https://swagger.io/specification/v2/#parameterObject" target="_blank">Parameter Object</a> 属性扩展，用于指定API入参定义与后端服务参数的映射关系。 .yaml文件格式示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   parameters:   - name: reqPath     in: path     required: true     type: string     x-backend-parameters:     - {location: path, name: backPath}     x-example: apigateway     description: request param in path ... </td> </tr> </tbody> </table> .json文件格式示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   "parameters":[       {           "name":"reqPath",           "in":"path",           "required":true,           "type":"string",           "description":"request param in path",           "x-backend-parameters":[               {                   "location":"path",                   "name":"backPath"               }           ],           "x-example":"apigateway"       }   ], ... </td> </tr> </tbody> </table> 参数说明： <img src="https://pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/pcp-portal-sca/20193010165904-13a8654e9b96.png" style="height:26px; margin:0px; width:65px" />：后端服务参数依赖于入参参数，当定义有入参参数时，可将该参数映射为后端参数（入参定义，可参考<a href="#id_01" target="_blank">x-example</a>） <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> location </td> <td> 是 </td> <td> string </td> <td> 后端服务参数的位置，目前支持：path、query、header。 </td> </tr> <tr> <td> name </td> <td> 是 </td> <td> string </td> <td> 后端服务参数的名称。 </td> </tr> </tbody> </table> • 10  x-backend：后端服务类型 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，用于描述API后端服务类型。 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-backend </td> <td style="vertical-align:top"> 是 </td> <td style="vertical-align:top"> string </td> <td> 后端服务类型，目前支持：HTTP/ HTTPS、MOCK </td> </tr> </tbody> </table> • 10.1  HTTP后端服务类型 含义：后端服务类型为HTTP/ HTTPS时，API网关可转发HTTP/HTTPS协议的请求。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... x-backend: - {address:'http://10.10.10.10:8888',method:ANY,path:'/back/{backPath}/{consPath}/{sysPath}',timeout: 6000, type: HTTP} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> type </td> <td> 是 </td> <td> string </td> <td> 后端服务类型：HTTP。 </td> </tr> <tr> <td> address </td> <td> 是 </td> <td> string </td> <td> 后端服务的地址。 </td> </tr> <tr> <td> path </td> <td> 是 </td> <td> string </td> <td> 后端服务的请求路径。 </td> </tr> <tr> <td> method </td> <td> 是 </td> <td> string </td> <td> 后端服务的请求方法：目前支持：GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY。 </td> </tr> <tr> <td> timeout </td> <td> 是 </td> <td> integer </td> <td> 后端请求超时阈值，取值范围：1-600000ms，默认情况是5000ms。 </td> </tr> <tr> <td> x-constant-parameters </td> <td> 否 </td> <td> Constatnt Object </td> <td> 常量参数，可参考<a href="#id_02" target="_blank">x-constant-parameters</a>。 </td> </tr> <tr> <td> x-system-parameters </td> <td> 否 </td> <td> System Object </td> <td> 系统参数，可参考<a href="#id_03" target="_blank">x-system-parameters</a>。 </td> </tr> </tbody> </table> • 10.2  MOCK后端服务类型 含义：后端服务类型为MOCK时，主要用于API的调试环境，不调用后端服务，直接返回设置的结果给API调用方。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...          x-backend:    mockHeaders:    - {name: PA001, value: 平安集团}    - {name: PA011, value: 平安科技}    mockResult: mock result    type: MOCK ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> type </td> <td> 是 </td> <td> string </td> <td> 后端服务类型：MOCK。 </td> </tr> <tr> <td> mockResult </td> <td> 是 </td> <td> string </td> <td> Mock返回结果。 </td> </tr> <tr> <td> mockHeaders </td> <td> 否 </td> <td> MockHeader Object </td> <td> Mock响应头，可参考mockHeaders。 </td> </tr> </tbody> </table> • 10.2.1  mockHeaders：Mock响应头参数 含义：MOCK响应头数据定义。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   mockHeaders:   - {name: PA011, value: 平安科技} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> name </td> <td> 是 </td> <td> string </td> <td> MOCK响应头的参数名称。 </td> </tr> <tr> <td> value </td> <td> 是 </td> <td> string </td> <td> MOCK响应头的参数取值。 </td> </tr> </tbody> </table> • 11  <a name="id_02">x-constant-parameters</a>：常量参数 含义：<a href="https://swagger.io/specification/v2/#parameterObject" target="_blank">Parameter Object </a>属性扩展，在后端服务类型为HTTP时，可设置API网关的常量参数。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   x-constant-parameters:   - {name: conPa, location: query, value: apigateway, description: The constant parameter in backend} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> name </td> <td> 是 </td> <td> string </td> <td> 常量参数的名称。 </td> </tr> <tr> <td> value </td> <td> 是 </td> <td> string </td> <td> 常量参数的取值。 </td> </tr> <tr> <td> location </td> <td> 是 </td> <td> string </td> <td> 常量参数的位置，目前支持：path、query、header。 </td> </tr> <tr> <td> description </td> <td> 否 </td> <td> string </td> <td> 常量参数的相关描述信息。 </td> </tr> </tbody> </table> • 12  <a name="id_03">x-system-parameters</a>：系统参数 含义：<a href="https://swagger.io/specification/v2/#parameterObject" target="_blank">Parameter Object</a> 属性扩展，在后端服务类型为HTTP时，可设置API网关的系统参数。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ...   x-system-parameters:   - {name: sysPa, location: query, value: PA-AG-RequestId} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="vertical-align:top"> 参数 </td> <td style="vertical-align:top"> 是否必选 </td> <td style="vertical-align:top"> 类型 </td> <td style="vertical-align:top"> 说明 </td> </tr> <tr> <td> name </td> <td> 是 </td> <td> string </td> <td> 系统参数的名称。 </td> </tr> <tr> <td> value </td> <td> 是 </td> <td> string </td> <td> 系统参数的取值：目前支持： <ul> <li>PA-AG-RequestId：客户端发送或API网关生成的API请求标识ID。</li> <li>PA-AG-Timestamp：客户端发送API请求时的时间戳。</li> <li>PA-AG-Env：客户端调用API的环境，默认情况是线上环境release。</li> <li>PA-AG-ClientIP：客户端的IP地址。</li> <li>PA-AG-AppId：客户端使用的应用（APP）的标识ID。</li> <li>PA-AG-GroupId：客户端调用的API所属分组的标识ID。</li> <li>PA-AG-UserId：客户端使用的应用（APP）的所属账户ID（TenantUUID）。</li> <li>PA-AG-Gateway-ChargeMode：调用API时付费模式。</li> <li>PA-AG-Gateway-Timestamp：API网关接受并处理API请求的时间戳。</li> </ul> </td> </tr> <tr> <td> location </td> <td> 是 </td> <td> string </td> <td> 系统参数的位置，目前支持：path、query、header。 </td> </tr> </tbody> </table> • 13  x-response-content-type：返回结果的内容类型 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，用于描述返回Content-type类型。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-response-content-type: application/xml;charset=utf-8 ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-response-content-type </td> <td> 是 </td> <td> string </td> <td> 调用API返回结果的内容类型，目前支持： <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> </tbody> </table> • 14  x-response-success-result：成功的返回结果 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，用于描述调用API成功时的返回结果。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-response-success-result: success ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-response-success-result </td> <td> 是 </td> <td> string </td> <td> 调用API成功，返回的响应结果。 </td> </tr> </tbody> </table> • 15  x-response-failure-result：失败的返回结果 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object </a>属性扩展，用于描述调用API失败时的返回结果。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       x-response-failure-result: error ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-response-failure-result </td> <td> 是 </td> <td> string </td> <td> 调用API失败，返回的响应结果。 </td> </tr> </tbody> </table> • 16  x-description：错误码 含义：<a href="https://swagger.io/specification/v2/#operationObject" target="_blank">Operation Object</a> 属性扩展，用于描述调用API出错时的错误信息。 示例： <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#f7f8fa; vertical-align:top"> ... paths:   '/path':     get:       responses:         '200': {description: success, x-description: 'success'} ... </td> </tr> </tbody> </table> 参数说明： <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td style="background-color:#ededed; vertical-align:top"> 参数 </td> <td style="background-color:#ededed; vertical-align:top"> 是否必选 </td> <td style="background-color:#ededed; vertical-align:top"> 类型 </td> <td style="background-color:#ededed; vertical-align:top"> 说明 </td> </tr> <tr> <td> x-description </td> <td> 否 </td> <td> string </td> <td> 调用API出错时的错误码，可作为排查报错信息的索引。 </td> </tr> </tbody> </table>

以上内容是否解决了您的问题？是否