更新时间:2024-07-17 GMT+08:00
分享

API中心发布

介绍如何将已开发好的API分享至API中心

前提条件

已完成服务商入驻。

操作步骤

  1. 单击项目名称,进入目标项目详情页面,单击“API发布 > API中心发布”

  2. 单击“申请发布”,跳转至“创建API资产”页面。
  3. 选择导入API、填写API资产信息,参数说明请分别参见表1表2

    表1 选择导入API

    参数名称

    说明

    导入方式

    CodeArts API:支持从CodeArts API工具直接把开发好的API文件一键式导入API中心。
    说明:

    从CodeArts API工具导入API资产时,导入方式会默认为“CodeArts API”。

    项目信息

    CodeArts API项目名称和ID。

    API接口

    当导入方式为“CodeArts API”时,支持勾选部分接口导入,如果导入全部接口,则忽略此参数。

    表2 资产基本信息

    参数名称

    说明

    资产名称

    自定义API资产的名称。

    图标

    为API资产设置一个图标。

    资产简介

    API资产的简单介绍,方便资产在API中心门户网站按描述被搜索。

    使用指南

    API资产的使用指导,帮助API调用者了解API的使用方法。

    资产域名

    API资产的域名

    分类

    选择资产行业分类,方便API资产在API中心门户网站按行业类别被搜索。

    可见范围

    • 公开:API资产创建成功后,所有用户都能在API中心门户网站中看到该API资产。
    • 私有:API资产创建成功后,仅当前用户能在API中心门户网站中看到该API资产。

    API来源

    API的来源,方便资产在API中心门户网站按来源被搜索。

    标签

    为该API资产添加分类属性,方便在大量创建API资产后,快速过滤和查找。

  4. 填写完API资产信息后,单击“立即创建”。
  5. 等待系统解析API文件,API资产所在行“状态”列如果显示“已上架”,说明解析完成,此时,API资产已成功分享至API中心门户网站。

相关文档