Skip to content

新建/导入接口

入口:【接口管理】=>【API管理】

接口分组

新增

  • 鼠标悬浮任意分组右侧更多按钮,在悬浮菜单中选择同级分组或者子级分组并点击 img.png

  • 在弹出的窗口中填入必要信息:

    • 分组名称:必填,且当前分组下唯一;
    • 分组代码:必填,且当前分组下唯一;
    • 前置分组:选填,用于排序,指定当前新增的分组在哪个分组后面,不填默认最前面;
    • 功能号段:选填,用于绑定功能号段,用于MA接口申请功能号;

img.png

  • 点击【确定】按钮,若信息无误,系统将添加该分组并刷新列表。

  • 点击【取消】按钮,系统将放弃添加分组。

编辑

  • 鼠标悬浮任意分组右侧更多按钮,在悬浮菜单中选择编辑并点击
  • 填入必填信息(具体参考: 分组新增
  • 点击【确定】按钮,若信息无误,将修改该分组并刷新列表。

删除

  • 鼠标悬浮任意分组右侧更多按钮,在悬浮菜单中选择删除并点击;系统将弹出警告
    • 点击【确定】按钮,若分组为空分组,则将删除该分组并刷新列表,否则提示错误信息;
    • 点击【取消】按钮,将放弃删除。

移动

  • 分组的移动支持拖拽:鼠标单击长按分组将其拖到指定分组下或分组后面即可;

接口新增

  • 鼠标悬浮任意分组,点击右侧+按钮,弹出接口新增表单(如果没有此按钮,代表可能没有权限或者当前没有未发布版本)
  • 在表单中填入必要信息:
    • 接口名称:必填,唯一;
    • 接口代码:必填,唯一;
    • 版本:必填,且只能选择最新的未发布版本,如果没有,则需要先到版本管理新增版本(参考版本管理
    • 标签:必填,外部:开放给客户使用的接口;内部:项目内部使用的接口;三方:第三方接口;默认外部;
    • 是否审批:必填,默认不审批,如果开启审批,则接口提交后,需要在版本管理发起审批(参考版本管理的版本发布部分);
    • 提交信息:必填,本次提交内容的简要描述;
    • 接口类型:目前支持JSTP、BEX、MA、REST四种类型,可多选,至少选择一个;选择具体协议后表单下方会出现各个协议的tab页签
  • 表单填写完毕后,点击保存按钮,如果表单内容验证通过,则新增成功,否则会给出相应的错误提示,按照提示内容修改表单后再次保存即可;

img.png

JSTP

接口类型选择JSTP时,需要填写此表单:

  • 功能号:必填,唯一,jstp功能号;
  • 接口描述:必填,jstp接口描述;
  • 请求参数,选填,点击【新增】,参数列表新增一行空白行;点击【从参数库新增】,右侧弹出参数库已有字段,选择指定字段可以新增一行参数,并填入选中字段的信息(参数库参考配置管理的参数库部分):
    • 参数代码:必填,请求内唯一;
    • 参数名称:必填;
    • 参数类型:JSTP参数类型;
    • 参数描述:选填;
    • 参数长度:只有部分类型的参数有长度,有长度则必填,否则不填;
    • 是否必填:必填,默认非必填;
    • 数据字典:选填,数据字典代码;
  • 多结果集,选填,点击返回参数右侧的新增按钮,返回参数下方会新增一个结果集,多次点击可新增多个结果集,结果集按自上而下的顺序排序,默认只有一个结果集;
  • 返回参数,选填,点击【新增】,参数列表新增一行空白行;点击【从参数库新增】,右侧弹出参数库已有字段,选择指定字段可以新增一行参数,并填入选中字段的信息(参数库参考配置管理的参数库部分):
    • 参数代码:必填,返回参数内唯一;
    • 参数名称:必填;
    • 参数类型:JSTP参数类型;
    • 参数描述:选填;
    • 参数长度:只有部分类型的参数有长度,有长度则必填,否则不填;
    • 数据字典:选填,数据字典代码;

img.png

BEX

接口类型选择BEX时,需要填写此表单:

1、接口基本信息:

  • api接口编号唯一标识bex接口;
  • bex类型支持联动,不同类型的bex接口需要的填写的表单信息不一样;

img.png

2、请求信息:

  • 参数代码参数内的同级参数唯一;
  • 参数类型不强制使用内置参数类型,可以自定义填写;
  • 复杂参数类型支持嵌套子级参数;
  • 支持从参数库新增;
  • 点击悬浮菜单的更多按钮,可以填写更详细的参数信息;

img.png

img.png

3、响应信息:

  • 参数代码参数内的同级参数唯一;
  • 参数类型不强制使用内置参数类型,可以自定义填写;
  • 复杂参数类型支持嵌套子级参数;
  • 支持从参数库新增;
  • 点击悬浮菜单的更多按钮,可以填写更详细的参数信息;

img.png

MA

接口类型选择MA时,需要填写此表单:

1、基本信息:

  • 功能号,必填,唯一,由8位纯数字或者首字符大写+8位纯数字组成;
    • 支持手动填写;
    • 如果当前接口所在分组或父分组有绑定功能号,则支持申请功能号,申请规则:
      1. 如果当前没有输入,则取分组绑定号段的第一个可用功能号;
      2. 如有输入,则在大于输入值且小于等于绑定号段最大值范围内取和输入值差值最小的可用功能号;
      3. 如有输入,且在大于输入值且小于等于绑定号段最大值范围内无可用功能号,则使用规则1;
      4. 如果没找到可用功能号,则提示异常;可通过修改号段范围(参考配置管理功能号段部分)或者手动录入解决
  • 功能类型,必填;
  • 接口描述:必填;

img.png

2、请求信息:

  • 参数代码,请求内唯一标识;
  • 支持从参数库新增;
  • 部分类型的参数支持填写参数长度,长度支持4则运算,例如:10*1024;
  • 鼠标点击fix域输入框时会有fix域填写提示:按标准fix域,已填写的fix出现次数由多到少排序,默认展示最多10条;

img.png

3、响应信息:

  • 参数代码,响应内唯一标识;
  • 支持从参数库新增;
  • 部分类型的参数支持填写参数长度,长度支持4则运算,例如:10*1024;
  • 鼠标点击fix域输入框时会有fix域填写提示:按标准fix域,已填写的fix出现次数由多到少排序,默认展示最多10条;

img.png

4、对于请求和响应信息中的fix域字段:

  • 填写规则:
    • 相同参数代码对应的fix相同;
    • 相同fix域对应的参数代码相同;
  • 接口保存时,会自动统计在不同接口中参数代码对应fix域的出现次数;

REST

接口类型选择REST时,需要填写此表单:

1、基本信息:

  • 请求方式,必填;
  • 接口路径,必填;
  • 接口描述:选填;

2、请求参数

  • body:支持POST等请求类型的接口配置body参数,支持OpenAPI规范左右参数类型,允许对象和列表嵌套
    • 内容格式:必填,可选json/form-data/x-www-form-urlencoded
    • root类型:必填,当内容格式是json时,可选Object/Array,设置json参数是对象还是列表;
    • 参数代码:必填,参数英文名;
    • 参数名称:必填,参数中文名;
    • 数据类型:必填,json类型可选integer/boolean/number/string/array/objectform-data可选integer/array/string/number/filex-www-form-urlencoded可选integer/array/string/number
    • 必填:参数是否必填;
    • 参数描述/说明:选填,参数详细描述;
    • 数据长度:json类型参数特有,选填,参数长度限制;
    • 精度:json类型参数特有,选填,number类型的参数可设置精度;
    • 默认值:json类型参数特有,选填,参数默认值;
    • 数据格式:json类型参数特有,对表OpenAPI format,不同参数类型可选不同值,具体参考OpenAPI specification;
    • 数据字典:json类型参数特有,选填,字段使用的数据字典。
  • header:所有接口都可设置header参数
    • 参数名:必填,参数中文名;
    • 类型:必填,可选integer/array/string/number;
    • 必填:参数是否必填;
    • 说明:参数描述。
  • query:
    • 参数名:必填,参数中文名;
    • 类型:必填,可选integer/array/string/number;
    • 必填:参数是否必填;
    • 说明:参数描述。
  • path:path参数不可直接添加,需要在接口路径中用{xx}占位,接口路径变更后,path参数自动更新,并且参数不可编辑
    • 参数名:不可编辑;
    • 类型:必填,可选integer/string/number
    • 必填:参数是否必填;
    • 说明:参数描述。
  • 响应参数
    • body:
      • 内容格式:必填,可选none/json/raw/binary,其中none/raw/binary不需要定义具体参数,json和请求参数body类似;
    • header:和请求参数一致

img.png

接口导入

对于存量接口,支持文件导入接口,具体导入支持如下:

  • JSTP:支持csv文件导入
  • BEX:支持xml文件导入
  • MA:支持csv文件导入
  • REST:支持swagger文档V1~V3.1版本的json和yaml文件导入;

导入模版下载

鼠标悬浮分组根节点右侧更多按钮,在悬浮菜单中选择下载模版并点击,弹出模版下载页面;

img.png

解压下载的zip文件,可以得到以下文件:

  • jstp导入文件格式说明.txt
  • jstp导入示例.csv
  • ma导入文件格式说明.txt
  • ma导入示例.csv
  • bex导入示例.xml

其中格式说明文件详细介绍了导入文件的填写规则及字段含义,导入示例文件是可以直接导入的示例文件,实际应用可基于示例文件按业务需求做修改;

导入

鼠标悬浮任意分组节点右侧更多按钮,在悬浮菜单中选择导入并点击,导入对话框:

img.png

填写说明:

  • 接口类型:目前支持的类型有:JSTP、BEX、MA、REST;
  • 策略:
    • 覆盖:如果导入的接口已存在,则覆盖;
    • 忽略:如果导入的接口已存在,则忽略该接口的导入;
    • 报错:如果导入的接口已存在,则提示错误信息,本次导入失败;
  • 文件:要导入的文件;
  • 导入的接口会保存在选择的分组下;
  • 点击【确认】,将尝试解析文件导入接口,如果导入的文件不满足格式要求,将提示错误信息,本次导入失败,如果信息无误,等待系统提示成功后,导入成功,自动刷新接口树;
  • 点击【取消】,放弃导入;