Logo
    立即注册
    数说方舟
    产品文档
    3.0 Swagger 导入接口
    最近更新时间:2023-02-28 10:28:01

    XDP 3.0 数据服务模块目前已支持通过 Swagger 快捷导入接口。

    入口:数据服务-XDP3.0

    操作步骤

    进入 XDP3.0 数据服务页面,点击新建服务,“新增方式”选择“导入Swagger”,支持通过上传文件和填写 URL 导入。

    file file


    注意事项

    1.目前导入将默认覆盖已存在的接口。判断(跟已有接口对比,先对比 path,再对比名称)逻辑:

    path 接口名称 结果
    相同 相同 覆盖,导入成功
    相同 不同 覆盖,导入成功
    不同 相同 报错,名称已被占用
    不同 不同 新增,导入成功

    ps:在 path 相同的情形下,如果修改了接口所在的目录,将会覆盖原来的目录。

    2.除了界面操作,支持通过调用接口进行导入。可将请求体中的参数mode配置为skip默认跳过已存在的接口。更多信息请联系平台客服。

    接口地址:https://xdp.datastory.com.cn/matrix_web/bi/openApi/v3/import

    3.Swagger 定义相关

    • 支持3个 XDP 扩展参数:
    x-xdp-domain:访问域名
    x-xdp-env: dev/uat/prd
    x-xdp-api-timeout: api访问上游服务器超时时间(可选)
    • localhost,127.0.0.1 开头的url 和 没有配置 XDP 扩展参数的 server info 会被无视

    • 单次导入时,Swagger 定义中 server 最多包含 dev,uat,prd 环境各一个

    微信扫描二维码在线咨询