發(fā)布API
在完成API測(cè)試后,您可以將API發(fā)布至API網(wǎng)關(guān)進(jìn)行托管,實(shí)現(xiàn)對(duì)API設(shè)計(jì)、開發(fā)、測(cè)試、發(fā)布、運(yùn)維監(jiān)測(cè)、安全管控以及下線等全生命周期管理。同時(shí),您也可以將API上架至阿里云API市場(chǎng),快速實(shí)現(xiàn)數(shù)據(jù)價(jià)值的變現(xiàn),最終形成商業(yè)閉環(huán)。本文為您介紹如何將API發(fā)布至API網(wǎng)關(guān)以及上架API至阿里云API市場(chǎng)。
前提條件
發(fā)布API前,您需先完成API測(cè)試。操作詳情請(qǐng)參見(jiàn)測(cè)試開發(fā)中的API。
創(chuàng)建并發(fā)布API前,請(qǐng)首先開通API網(wǎng)關(guān)。
背景信息
API網(wǎng)關(guān)提供API托管服務(wù),涵蓋API發(fā)布、管理、運(yùn)維、售賣的全生命周期管理,并圍繞API提供了權(quán)限管理、流量控制、訪問(wèn)控制等服務(wù)。幫助您簡(jiǎn)單、快速、低成本、低風(fēng)險(xiǎn)地實(shí)現(xiàn)微服務(wù)聚合、前后端分離、系統(tǒng)集成,向合作伙伴、開發(fā)者開放功能和數(shù)據(jù)。在數(shù)據(jù)服務(wù)中執(zhí)行發(fā)布API時(shí),本質(zhì)上即為將API發(fā)布至API網(wǎng)關(guān),從而自動(dòng)生成在線調(diào)用地址。API網(wǎng)關(guān)的產(chǎn)品詳情請(qǐng)參見(jiàn)產(chǎn)品簡(jiǎn)介。
同時(shí)數(shù)據(jù)服務(wù)還支持您將API上架至阿里云API市場(chǎng)。操作詳情請(qǐng)參見(jiàn)下文的上架至阿里云API市場(chǎng)。
發(fā)布至API網(wǎng)關(guān)
進(jìn)入數(shù)據(jù)服務(wù)頁(yè)面。
登錄DataWorks控制臺(tái),切換至目標(biāo)地域后,單擊左側(cè)導(dǎo)航欄的 ,在下拉框中選擇對(duì)應(yīng)工作空間后單擊進(jìn)入數(shù)據(jù)服務(wù)。
在服務(wù)開發(fā)頁(yè)面的API列表中,雙擊相應(yīng)的API名稱,進(jìn)入API編輯頁(yè)面后單擊右上方的提交。
說(shuō)明僅完成測(cè)試的API可進(jìn)行提交操作,如果還未完成測(cè)試,請(qǐng)先進(jìn)行測(cè)試。操作詳情請(qǐng)參見(jiàn)測(cè)試API。
當(dāng)頂部提示提交成功后,API即已完成提交,會(huì)自動(dòng)生成一個(gè)API版本,您可以在彈出的版本頁(yè)面中查看當(dāng)前提交API的版本信息,如API的狀態(tài)。
提交發(fā)布API申請(qǐng)。
在右側(cè)的版本頁(yè)面中,找到待申請(qǐng)發(fā)布的API版本,單擊申請(qǐng)發(fā)布,跳轉(zhuǎn)至申請(qǐng)發(fā)布頁(yè)面。
根據(jù)界面提示,輸入申請(qǐng)?jiān)虿螕?b data-tag="uicontrol" id="uicontrol-ssh-ji5-dm1" class="uicontrol">申請(qǐng)權(quán)限提交發(fā)布API申請(qǐng)。
說(shuō)明工作空間定義審批流后需要走流程審批才可以發(fā)布API,詳情請(qǐng)參見(jiàn):審批中心概述。
等待發(fā)布API申請(qǐng)審批。
提交發(fā)布申請(qǐng)后,根據(jù)審批中心制定的審批策略,需審核人員完成審批您才可以繼續(xù)后續(xù)API發(fā)布操作。審批人可在審批中心的待我審批頁(yè)面查看申請(qǐng)?jiān)斍椋⑦M(jìn)行審批。
說(shuō)明審批通過(guò)后,API在版本頁(yè)面的狀態(tài)會(huì)從待申請(qǐng)變?yōu)?b data-tag="uicontrol" id="uicontrol-3qm-zkc-zkj" class="uicontrol">可發(fā)布。
發(fā)布API。
審批人審批通過(guò)后,您可以在API編輯頁(yè)面的右側(cè)導(dǎo)航欄中,單擊版本,找到審批通過(guò)的待發(fā)布API,單擊發(fā)布。
當(dāng)界面提示發(fā)布成功后,DataWorks會(huì)根據(jù)API所屬業(yè)務(wù)流程的關(guān)聯(lián)分組(通過(guò)在數(shù)據(jù)服務(wù)中右鍵
可以看到具體的分組名稱),將API發(fā)布至API網(wǎng)關(guān)中的對(duì)應(yīng)分組中。發(fā)布成功后您也可以在API網(wǎng)關(guān)產(chǎn)品的 中查看已發(fā)布的API信息。
發(fā)布完成后,您可以進(jìn)入API網(wǎng)關(guān)控制臺(tái)查看API信息,也可以在API網(wǎng)關(guān)設(shè)置流量控制、訪問(wèn)控制等功能。
如果您的API是為了供自己的應(yīng)用程序調(diào)用,需要在API網(wǎng)關(guān)中創(chuàng)建應(yīng)用,將API授權(quán)到應(yīng)用中,然后通過(guò)AppKey和AppSecret加密簽名調(diào)用,詳情請(qǐng)參見(jiàn)客戶端調(diào)用API示例。同時(shí)API網(wǎng)關(guān)提供了主流編程語(yǔ)言的SDK,您可以快速集成API至自己的應(yīng)用中,詳情請(qǐng)參見(jiàn)SDK下載及使用指南。
上架至阿里云API市場(chǎng)
阿里云API市場(chǎng)涵蓋了金融理財(cái)、人工智能、電子商務(wù)、交通地理、生活服務(wù)、企業(yè)管理和公共事務(wù)8大類目,目前已有數(shù)千款A(yù)PI產(chǎn)品在線售賣,是快速幫您實(shí)現(xiàn)數(shù)據(jù)變現(xiàn)的平臺(tái)。
數(shù)據(jù)服務(wù)生成和注冊(cè)的API發(fā)布至API網(wǎng)關(guān)后,可以一鍵上架至阿里云API市場(chǎng)售賣,幫助企業(yè)快速實(shí)現(xiàn)數(shù)據(jù)價(jià)值變現(xiàn),最終形成商業(yè)閉環(huán)。
在上架API至阿里云API市場(chǎng)中銷售之前,首先要以服務(wù)商的身份入駐阿里云云市場(chǎng),流程詳見(jiàn)云市場(chǎng)入駐流程及類目資質(zhì)申請(qǐng)說(shuō)明。
僅支持企業(yè)入駐阿里云API市場(chǎng)。
進(jìn)入阿里云服務(wù)商平臺(tái)。
在左側(cè)導(dǎo)航欄,單擊 。
單擊發(fā)布商品。
在接入信息頁(yè)面,配置各項(xiàng)參數(shù)。詳情請(qǐng)參見(jiàn)API類商品接入說(shuō)明。