跳到主要内容

TCP方法设计

提示

创建TCP协议，需要先新建TCP客户端，保存成功后，再在客户端下新建TCP方法
设计的主要作用是为了满足研发人员APIfirst的开发习惯，可以预先定义接口请求参数以及响应期望，如果您仅仅需要调试接口，直接进 调试 页面即可，无需在 设计 页面预先定义。

新建TCP方法​

在目录侧找到TCP客户端，更多操作——新建TCP方法

image.png

基本信息​

警告

TCP方法的服务地址是跟随父级客户端的服务地址，不可直接修改，智能在客户端处修改服务地址

组 56.png

请求报文​

支持ISO8583 定长报文 分隔符报文 raw（xml/json/text/）格式的请求报文

ISO8583格式​

ISO 8583是一个用于金融交易信息交换的国际标准 image.png

在使用ISO8583格式发送报文时，模板经常会遇到复用的情况，因此提供了模板管理功能，可以快速管理使用模板

组 57.png

组 58.png

定长报文​

支持设定报文每个参数值的固定长度，当长度不够时可以设置他的补充规则 image.png

如何设置填充规则

组 59.png

分隔符报文​

支持设定报文每个参数值之间的分隔符

image.png

如何设置分隔符规则

组 60.png

raw​

当您需要发送JSON/XML/Text格式时，切换到对应的raw类型即可 raw（json/xml）格式，支持可视化编辑（可以了解数据结构的使用）设计带层级接口的json或xml的请求报文

组 62.png

组 63.png

raw（Text）支持源码编辑方式设计入参的参数值

image.png

响应报文​

主要呈现在接口文档中，向使用接口的人展示该TCP方法的响应示例是什么样的结构

新建期望​

点击【新建期望】，我们可以选择该期望的状态码、填写期望名称、选择内容格式，点击【确定】新建成功

image.png

设计数据结构​

我们可以选择JSON、XML、 HTML、 Binary四种内容格式，其中JSON/XML格式可以通过可视化的方式设计响应期望返回的数据结构（可以了解数据结构的使用）

image.png

设计响应示例值​

设计好的数据结构也可以mock生成响应示例值

组 61.png