更新时间:2024-12-13 GMT+08:00
分享

推送接口

CodeArts API支持将设计完成的接口推送至第三方URL

  1. 单击“项目设置 > 导出数据”,默认进入“第三方推送”页签。

  2. 单击“新建”,弹出“新增同步任务”窗口。

  3. 配置任务参数,参数配置请参考下表。

    参数

    配置说明

    任务名称

    同步任务名称,只允许输入字母、汉字、数字、下划线、中划线,长度3-64个字符。

    数据源格式

    支持OpenAPI 3.0、Swagger 2.0格式。

    数据源URL

    支持YAML、JSON。

    第三方URL

    第三方URL地址。

    Auth

    推送URL的认证类型。

    • No Auth:表示无认证。
    • API Key:使用 API Key 进行身份验证
    • Bearer Token:用于身份验证的访问令牌,授权持有者(Bearer)访问资源的权限。
    • Basic Auth: 基本认证,一种HTTP认证协议,用于在客户端和服务器之间进行身份验证
    • Huawei IAM:华为云IAM认证,通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求,关于AK/SK获取方式请参照AK/SK认证

    Header

    推送URL的请求头参数。

  4. 单击“确定”,完成同步任务创建。
  5. 在“第三方推送”页面单击操作的立即执行同步任务。

相关文档