# 接口对接文档

项目名称 | {$item.title}
最终解析权 | 文档提供方
当前版本号 |  | 文件类型 | 接口方案
文档状态 | 受控■ 非受控□ 作废□
版本更新时间 | {$item.update_time|date="Y-m-d H:i:s"} | 文档发布时间 | {:date('Y-m-d H:i:s', time())}

## 文档目录结构

- 接口说明
- 状态码
{foreach $api as $k=>$v}
- {$k+1}、{$v.title}
{foreach $v.list as $key=>$val}
- {$val.title}
{/foreach} {/foreach}

## 接口说明

{if (!$item.content)}暂无{else /}{$item.content|raw}{/if}

## 状态码

Code | Msg | Success | 类型
{foreach $code as $v}
{$v.code} | {$v.msg|raw} | {if ($v.is_success==1)}是{else/}否{/if} | {$v.param_type}
{/foreach}

{foreach $api as $kkey=>$val} {foreach $val.list as $num=>$v}

## {$v.title}

A、接口地址： {$v.host_url}
B、请求方式： {$v.type}
C、请求格式： {$v.param}
D、返回值格式： {$v.return_type}
E、请求参数： {if ($v.body)}

参数名 | 类型 | 必填 | 默认值 | 说明
{foreach $v.body as $vv}
{$vv.field} | {$vv.param_type}{if ($vv.size)}({$vv.size}){/if} | {if ($vv.no_null==1)}是{else /}否{/if} | {$vv.default} | {$vv.title}
{/foreach}

{else /} 无 {/if}
F、请求头： {if ($v.request)}

参数名 | 类型 | 必填 | 说明
{foreach $v.request as $vv}
{$vv.field} | {$vv.param_type} | {if ($vv.no_null==1)}是{else /}否{/if} | {$vv.title}
{/foreach}

{else /} 无 {/if}
G、响应数据（数据集部分）： {if ($v.return)}

参数名 | 类型 | 必填 | 默认值 | 说明
{foreach $v.return as $vv}
{$vv.field} | {$vv.param_type}{if ($vv.size)}({$vv.size}){/if} | {if ($vv.no_null==1)}是{else /}否{/if} | {$vv.default} | {$vv.title}
{/foreach}

{else /} 无 {/if}
H、响应请求头： {if ($v.return_request)}

参数名 | 类型 | 必填 | 说明
{foreach $v.return_request as $vv}
{$vv.field} | {$vv.param_type}{if ($vv.size)}({$vv.size}){/if} | {if ($vv.no_null==1)}是{else /}否{/if} | {$vv.title}
{/foreach}

{else /} 无 {/if}
I、返回值结构： {if ($v.return_field)}

参数名 | 是否Code值 | 是否Data值 | 说明
{foreach $v.return_field as $vv}
{$vv.field} | {if ($vv.is_code==1)}是{else /}否{/if} | {if ($vv.is_data==1)}是{else /}否{/if} | {$vv.title}
{/foreach}

{else /} 无 {/if}
J、状态码：

Code | Msg | 类型 | is_Success
{foreach $v.return_code as $vv}
{$vv.code} | {$vv.msg} | {$vv.param_type} | {if ($vv.is_success==1)}是{else /}否{/if}
{/foreach}

K、成功示例： {if ($v.success_list)} {foreach $v.success_list as $i=>$vv}
{if ($vv.scene)}{$vv.scene}{else /}{$i+1}{/if}： {$vv.des}
{$vv.json|raw}
{/foreach} {else /} 无 {/if}
L、失败示例： {if ($v.error_list)} {foreach $v.error_list as $i=>$vv}
{if ($vv.scene)}{$vv.scene}{else /}{$i+1}{/if}： {$vv.des}
{$vv.json|raw}
{/foreach} {else /} 无 {/if}
{/foreach} {/foreach}