管理應(yīng)用接口
接口管理對(duì)應(yīng)用接口定義進(jìn)行統(tǒng)一管理,支持根據(jù)代碼中的@RestController
等注解,進(jìn)行接口掃描并上報(bào)回平臺(tái)。本文介紹如何配置接口管理規(guī)則、新建接口和數(shù)據(jù)模型。
新建或?qū)虢涌?/b>
新建接口
登錄BizWorks,在選擇平臺(tái)下拉列表中選中微服務(wù)開發(fā)平臺(tái)。
單擊頁面右上角圖標(biāo)或其文本框區(qū)域,在下拉列表中單擊目標(biāo)項(xiàng)目名稱后,單擊應(yīng)用頁簽。在應(yīng)用列表頁面單擊目標(biāo)中心應(yīng)用名稱。
在目標(biāo)中心應(yīng)用左側(cè)導(dǎo)航欄中,選擇 。
在應(yīng)用接口管理頁面,選擇 。
在新建接口面板,完成接口名稱、接口路徑和請(qǐng)求參數(shù)等設(shè)置后,單擊保存。
說明是否注冊(cè)網(wǎng)關(guān)
新增的接口(例如:導(dǎo)入、反掃、模型自動(dòng)生成各種方式),默認(rèn)該選項(xiàng)為開啟狀態(tài)。
接口注冊(cè)網(wǎng)關(guān)后,可提供集群外訪問的統(tǒng)一入口,并提供安全防護(hù)能力。
如果接口開啟了注冊(cè)網(wǎng)關(guān)配置,且應(yīng)用部署的環(huán)境配置了網(wǎng)關(guān)服務(wù)(網(wǎng)關(guān)實(shí)例詳見項(xiàng)目環(huán)境與集群信息),則會(huì)在應(yīng)用部署時(shí)將應(yīng)用接口注冊(cè)到對(duì)應(yīng)的網(wǎng)關(guān)服務(wù)。
如果不開啟該選項(xiàng),則應(yīng)用部署后接口不會(huì)注冊(cè)至網(wǎng)關(guān),僅支持集群內(nèi)訪問,且該應(yīng)用接口信息不會(huì)自動(dòng)同步至開放平臺(tái)。
配置變更后需要重新部署應(yīng)用才能生效。
是否啟用認(rèn)證
該功能僅在接口注冊(cè)至網(wǎng)關(guān)服務(wù)后生效。
應(yīng)用部署后向網(wǎng)關(guān)注冊(cè)應(yīng)用接口時(shí),平臺(tái)根據(jù)該字段判斷是否需要開啟安全認(rèn)證。
如果狀態(tài)為默認(rèn),則是否開啟安全認(rèn)證根據(jù)接口全局配置決定。
如果狀態(tài)為開啟,則不管全局配置是否開啟,接口在任意環(huán)境部署時(shí)都將開啟安全認(rèn)證。
如果狀態(tài)為關(guān)閉,則不管全局配置是否開啟,接口在任意環(huán)境部署時(shí)都將關(guān)閉安全認(rèn)證。
配置變更后需要重新部署應(yīng)用才能生效。
可選:新建數(shù)據(jù)模型和新建目錄。
新建數(shù)據(jù)模型
在應(yīng)用接口管理頁面,選擇 。
在新建數(shù)據(jù)模型面板,完成相關(guān)配置項(xiàng)設(shè)置后,單擊保存。
新建目錄
在應(yīng)用接口管理頁面,選擇 。
在新建子目錄對(duì)話框中,完成相關(guān)配置項(xiàng)設(shè)置后,單擊添加。
可選:單擊目標(biāo)接口名稱右側(cè)操作列下的查看,或者在左側(cè)導(dǎo)航欄中單擊目標(biāo)接口(數(shù)據(jù)模型)。
在目標(biāo)接口(或數(shù)據(jù)模型)的詳情頁面,查看詳細(xì)信息。
可選:在目標(biāo)接口的詳情頁面的右上角,選擇
(或 )。
導(dǎo)入接口
在應(yīng)用接口管理頁面,選擇 。
在批量導(dǎo)入面板,單擊或拖拽目標(biāo)Swagger文件至虛線框內(nèi)(僅支持OAS 2標(biāo)準(zhǔn)),完成文件上傳操作后,單擊開始導(dǎo)入。
編輯接口
在應(yīng)用接口管理頁面,單擊目標(biāo)接口右側(cè)操作列下的編輯。
在編輯接口面板,完成相關(guān)配置項(xiàng)編輯,單擊保存。
批量刪除接口
在應(yīng)用接口管理頁面,選中目標(biāo)接口(單個(gè)或多個(gè))后,單擊批量刪除。
在二次確認(rèn)對(duì)話框中,單擊刪除。
刪除接口
在應(yīng)用接口管理頁面,單擊目標(biāo)接口右側(cè)操作列下的 。
在二次確認(rèn)對(duì)話框中,單擊刪除。
在線調(diào)試接口
在應(yīng)用接口管理頁面,您可以單擊目標(biāo)接口名稱右側(cè)操作列下的
。在在線調(diào)試下拉列表中選擇目標(biāo)環(huán)境后,按需完成相關(guān)參數(shù)設(shè)置,單擊發(fā)起調(diào)用。
如果頁面提示:該環(huán)境中未部署過此應(yīng)用,需要先部署才可以開始調(diào)試。請(qǐng)單擊立刻部署,后續(xù)操作步驟,請(qǐng)參見部署中心應(yīng)用實(shí)例。
啟用或關(guān)閉Mock功能
啟用Mock功能
在應(yīng)用接口管理頁面,您可以單擊目標(biāo)接口名稱。
單擊Mock頁簽后,單擊啟用Mock功能。
在編輯Mock配置面板,選擇HTTP Status Code,按需完成配置后,單擊保存。
關(guān)閉Mock功能
在Mock頁簽,單擊關(guān)閉接口Mock。
在二次確認(rèn)對(duì)話框中,單擊確定。
重要關(guān)閉接口Mock后,接口Mock服務(wù)將無法訪問,所有Mock配置不會(huì)被清理,當(dāng)您重新啟用接口Mock時(shí)可以繼續(xù)使用。
配置接口管理規(guī)則
在應(yīng)用接口管理頁面,單擊配置接口管理規(guī)則。
在配置接口管理規(guī)則面板,完成以下信息配置。
參數(shù)
說明
自動(dòng)規(guī)則版本
在自動(dòng)規(guī)則版本下拉列表中選擇目標(biāo)自動(dòng)規(guī)則版本。
接口認(rèn)證
您可以選擇需要開啟接口認(rèn)證的環(huán)境類型,支持開發(fā)、測(cè)試、預(yù)發(fā)和生成。
應(yīng)用部署的環(huán)境類型如果未開啟接口認(rèn)證,則從集群內(nèi)部、集群外部調(diào)用應(yīng)用接口時(shí)無需認(rèn)證,可直接調(diào)用。
應(yīng)用部署的環(huán)境類型如果開啟了接口認(rèn)證,則從集群內(nèi)部調(diào)用應(yīng)用接口時(shí)無需認(rèn)證,從集群外部調(diào)用時(shí),需要配置接口認(rèn)證信息。
修改配置后,您需要重新部署中心應(yīng)用才可生效。
單擊確定。
代碼掃描上報(bào)接口信息
在應(yīng)用接口管理頁面,單擊接口掃描。
在代碼掃描上報(bào)接口信息面板,單擊掃描代碼分支。在掃描代碼分支面板的代碼分支下拉列表中選中目標(biāo)代碼分支后,單擊提交。
您可以在代碼掃描上報(bào)接口信息面板查看代碼掃描狀態(tài),如果上報(bào)成功,則接口信息更新成功;如果上報(bào)失敗,則可查看失敗的原因。您可以單擊刷新,查看最新代碼掃描狀態(tài)。