全部產品
Search
文件中心

DataWorks:發布API

更新時間:Jun 19, 2024

在完成API測試後,您可以將API發布至API Gateway進行託管,實現對API設計、開發、測試、發布、營運監測、安全管控以及下線等全生命週期管理。同時,您也可以將API上架至阿里雲API市場,快速實現資料價值的變現,最終形成商業閉環。本文為您介紹如何將API發布至API Gateway以及上架API至阿里雲API市場。

前提條件

背景資訊

API Gateway提供API託管服務,涵蓋API發布、管理、營運、售賣的全生命週期管理,並圍繞API提供了許可權管理、流量控制、存取控制等服務。協助您簡單、快速、低成本、低風險地實現微服務彙總、前後端分離、系統整合,向夥伴、開發人員開放功能和資料。在資料服務中執行發布API時,本質上即為將API發布至API Gateway,從而自動產生線上調用地址。API Gateway的產品詳情請參見產品簡介

同時資料服務還支援您將API上架至阿里雲API市場。操作詳情請參見下文的上架至阿里雲API市場

發布至API Gateway

  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 Gateway中的對應分組中。發布成功後您也可以在API Gateway產品的開放API > API列表中查看發行的API資訊。

發布完成後,您可以進入API Gateway控制台查看API資訊,也可以在API Gateway設定流量控制、存取控制等功能。

如果您的API是為了供自己的應用程式調用,需要在API Gateway中建立應用,將API授權到應用中,然後通過AppKey和AppSecret加密簽名調用,詳情請參見用戶端調用API樣本。同時API Gateway提供了主流程式設計語言的SDK,您可以快速整合API至自己的應用中,詳情請參見SDK下載及使用指南

上架至阿里雲API市場

阿里雲API市場涵蓋了金融理財、人工智慧、電子商務、交通地理、生活服務、企業管理和公用事務8大類目,目前已有數千款API產品線上售賣,是快速幫您實現資料變現的平台。

資料服務產生和註冊的API發布至API Gateway後,可以一鍵上架至阿里雲API市場售賣,協助企業快速實現資料價值變現,最終形成商業閉環。

在上架API至阿里雲API市場中銷售之前,首先要以服務商的身份入駐阿里雲雲市場。

說明

僅支援企業入駐阿里雲API市場。

  1. 進入阿里雲服務商平台。

  2. 在左側導覽列,單擊商品 > 商品管理

  3. 單擊發布商品

  4. 接入資訊頁面,配置各項參數。