API发布者操作指南-- ③API导入导出

栏目:云苍穹知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

API发布者操作指南-- ③API导入导出

API导入导出是对API集合能够导出成swagger2.0 json格式文件,导入swagger json格式文件以便对API进行批量创建。包括API分组菜单下的API导出、API管理菜单下不同分组的API导出以及API配置导入和立即导入功能。


1 API导入

1.1 基本选项

需要选择导入后的分组,是否打开覆盖现有的开关,如果是普通swagger json文件需要点下一步配置才能导入,如是通过系统的API导出功能导出的swagger json文件可以直接点导入并完成。



注意事项:

  1. 覆盖现有勾选后,如果当前swagger文件API定义summary字段命名和当前项目中分组内API有相同命名,会覆盖现有的API(可能在其它分组下)。如果swagger文件API定义path+method和当前选择组内有相同path+method的API,会覆盖现有组的API。

  2. json文件必须是合法的swagger 2.0文件,不勾选覆盖复选框下,如果出现API名称相同、path+method相同、路径参数不匹配等情况下需要修改json文件让其校验合法。

  3. 立即导入必须是API导出功能导出的swagger有扩展字段的json文件。


1.2 全局配置

全局配置是对导入的所有的API进行一个全局默认的配置,避免在每个API下重复配置操作。



  • 类型:公开类型,且在RELEASE环境上发布的API可以上架订阅。

  • 安全认证:调用API时的认证方式。Appkey & Appsecret安全级别高,推荐使用。

  • 权限等级:分为普通和高级。高级接口,API调用方需先申请,待API提供者审批通过后才能使用。

  • 匹配模式:包含绝对匹配和前缀匹配。

  • 支持跨域: 默认不开启。目前支持简单请求和非简单请求的跨域两种方式。

  • 请求协议:支持HTTP和HTTPS。

  • 请求方式:支持GET、POST、DELETE、PUT、HEAD、PATCH、OPTIONS、ANY,ANY表示任意Method。当Method为POST、PUT、PATCH时需要配置请求Body相关内容。

  • 后端名称:默认为 默认后端。

  • 后端服务类型:默认为网络地址。

  • 后端服务地址:指名后端资源所在主机的地址,支持域名、IP形式,不可重复。

  • 权重值:指名多后端地址轮询时,当前地址的权重,取值为1~100之间的整型值,默认为1。当具有多个后端地址时生效。

  • 后端分发策略:支持按次轮询和按权重轮询2种方式。

  • 后端超时:默认5000ms。


1.3 接口配置

接口配置是对具体单个API下接口进行单独配置,默认就是全局配置下的配置。



1.3.1 前端请求



  • 参数名称:发起API调用时需要使用的参数名称,不可重复。

  • 参数位置:支持PATH、QUERY、HEADER。

  • 类型:支持STRING,NUMBER类型。

  • 必填:参数是否必填,如设置成必填后,实际请求时没用该参数,则请求会被拒绝。

  • 描述:参数的描述。


注意:当请求PATH中包含了PATH路径参数时,须在请求PATH中也定义相同名称的请求入参参数。


1.3.2 参数编排


建立和请求入参的映射关系,默认入参和后端参数名相同,点击修改按钮可单独通行修改映射关系。



注意:当请求PATH中包含了PATH路径参数时,须在后端服务参数列表中也定义相同名称的后端服务参数。


1.3.3 后端定义


默认是全局的配置,点击编辑可以单独对后端服务配置。



1.3.4 返回结果


成功或者失败调用API时,返回的响应信息示例。



2 API导出

2.1 API分组导出

点击列表操作列的“更多-导出API”按钮,可直接该分组下所有API,导出的格式为swagger2.0带有扩展字段的 json文件。



2.2 API管理导出

点击列表中具体API,操作列的“导出API”按钮,导出所选择的API,导出的格式为swagger2.0带有扩展字段的 json文件。



注意:不能选择不同分组下path+method相同的API导出。


API发布者操作指南-- ③API导入导出

API导入导出是对API集合能够导出成swagger2.0 json格式文件,导入swagger json格式文件以便对API进行批量创建。包括API分组菜单下的API导...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息