文档首页/ API中心 API Hub/ 快速入门/ 开放API/ 上架API至API中心门户网站
更新时间:2023-12-08 GMT+08:00
分享

上架API至API中心门户网站

使用场景

如果您想要将已开发好的API上架至API中心门户网站,请参考本章指导操作。

前提条件

已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。

操作步骤

  1. 进入API中心服务页面
  2. 选择左侧导航栏中的API资产管理 > API资产
  3. 单击页面右上角的“创建API资产”
  4. 填写API资产信息。

    1. 根据表1参数信息,配置选择导入API。
      表1 选择导入API

      参数名称

      说明

      导入方式

      支持以下6种方式,上架API文件至API中心门户网站:

      • OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。
      • API网关:支持将API网关代理中已发布的API,上架至API中心门户网站。
      • Postman Collection:支持将Postman Collection开发的API,上架至API中心门户网站。
      • Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。
      • URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。
      • API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。
        说明:
        • 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。
        • 如果您的Markdown压缩包中文件的数量超过100个,导致文件无法导入,您可以通过向系统提交工单来寻求帮助。

      上传文件

      选择本地API文件上传。

      API分组

      “导入方式”选择“API网关”时,支持选择API网关代理中的API分组。

      API接口

      “导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。

      • OpenAPI
      • API网关
      • Postman Collection
      • API Arts

      API URL

      “导入方式”“URL”时,需要填写API资产的URL地址。

    2. 根据表2参数信息配置资产基本信息。
      表2 资产基本信息

      参数名称

      说明

      资产名称

      自定义API资产的名称。

      说明:

      同一个华为云账号下的API资产名称不能重复。

      图标

      为API资产设置一个图标。如果不设置,则显示默认图标。

      资产简介

      简单介绍下API资产的行业,用途等。

      使用指南

      描述API的调用方法。

      资产域名

      API服务的主机域名或IP,用于API在线调试。

      分类

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

      可见范围

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

      标签

      为该API资产添加个性标签,方便用户通过标签了解API资产的特点。

  5. 填写完API资产信息后,单击“立即创建”。

    等待系统解析API文件。API资产所在行“状态”列如果显示“已上架”,说明解析完成。此时,API资产已成功上架至API中心门户网站

相关文档