文档

发布API

更新时间:

在完成API测试后,您可以将API发布至API网关进行托管,实现对API设计、开发、测试、发布、运维监测、安全管控以及下线等全生命周期管理。同时,您也可以将API上架至阿里云API市场,快速实现数据价值的变现,最终形成商业闭环。本文为您介绍如何将API发布至API网关以及上架API至阿里云API市场。

前提条件

背景信息

API网关提供API托管服务,涵盖API发布、管理、运维、售卖的全生命周期管理,并围绕API提供了权限管理、流量控制、访问控制等服务。帮助您简单、快速、低成本、低风险地实现微服务聚合、前后端分离、系统集成,向合作伙伴、开发者开放功能和数据。在数据服务中执行发布API时,本质上即为将API发布至API网关,从而自动生成在线调用地址。API网关的产品详情请参见产品简介

同时数据服务还支持您将API上架至阿里云API市场。操作详情请参见下文的上架至阿里云API市场

发布至API网关

  1. 进入数据服务页面。

    登录DataWorks控制台,单击左侧导航栏的数据服务,在下拉框中选择对应工作空间后单击进入数据服务

  2. 服务开发页面的API列表中,双击相应的API名称,进入API编辑页面后单击右上方的提交

    说明

    仅完成测试的API可进行提交操作,如果还未完成测试,请先进行测试。操作详情请参见测试API

    当顶部提示提交成功后,API即已完成提交,会自动生成一个API版本,您可以在弹出的版本页面中查看当前提交API的版本信息,如API的状态。版本

  3. 提交发布API申请。

    1. 在右侧的版本页面中,找到待申请发布的API版本,单击申请发布,跳转至申请发布页面。

    2. 根据界面提示,输入申请原因并单击申请权限提交发布API申请。

      说明

      工作空间定义审批流后需要走流程审批才可以发布API,详情请参见:审批中心概述

  4. 等待发布API申请审批。

    提交发布申请后,根据审批中心制定的审批策略,需审核人员完成审批您才可以继续后续API发布操作。审批人可在审批中心待我审批页面查看申请详情,并进行审批。

    说明

    审批通过后,API在版本页面的状态会从待申请变为可发布

  5. 发布API。

    审批人审批通过后,您可以在API编辑页面的右侧导航栏中,单击版本,找到审批通过的待发布API,单击发布

    当界面提示发布成功后,DataWorks会根据API所属业务流程的关联分组(通过在数据服务中右键业务流程 > 修改属性可以看到具体的分组名称),将API发布至API网关中的对应分组中。发布成功后您也可以在API网关产品的开放API > API列表中查看已发布的API信息。

发布完成后,您可以进入API网关控制台查看API信息,也可以在API网关设置流量控制、访问控制等功能。

如果您的API是为了供自己的应用程序调用,需要在API网关中创建应用,将API授权到应用中,然后通过AppKey和AppSecret加密签名调用,详情请参见客户端调用API示例。同时API网关提供了主流编程语言的SDK,您可以快速集成API至自己的应用中,详情请参见SDK下载及使用指南

上架至阿里云API市场

阿里云API市场涵盖了金融理财、人工智能、电子商务、交通地理、生活服务、企业管理和公共事务8大类目,目前已有数千款API产品在线售卖,是快速帮您实现数据变现的平台。

数据服务生成和注册的API发布至API网关后,可以一键上架至阿里云API市场售卖,帮助企业快速实现数据价值变现,最终形成商业闭环。

在上架API至阿里云API市场中销售之前,首先要以服务商的身份入驻阿里云云市场,流程详见云市场入驻流程说明

说明

仅支持企业入驻阿里云API市场。

  1. 进入阿里云服务商平台

  2. 在左侧导航栏,单击商品 > 商品管理

  3. 单击发布商品

  4. 接入信息页面,配置各项参数。详情请参见API类商品接入说明

  • 本页导读 (1)