數(shù)據(jù)結(jié)構(gòu)

2018-10-30 15:11 更新

簡介

您可以將通用的數(shù)據(jù)結(jié)構(gòu)保存起來,方便在API文檔中進行重用,并且當數(shù)據(jù)結(jié)構(gòu)發(fā)生改變時,所有引用了該數(shù)據(jù)結(jié)構(gòu)的API文檔均會同步發(fā)生改變。

創(chuàng)建數(shù)據(jù)結(jié)構(gòu)

進入 數(shù)據(jù)結(jié)構(gòu)管理 頁面,點擊 創(chuàng)建數(shù)據(jù)結(jié)構(gòu) 按鈕,輸入相關(guān)信息并點擊 保存 按鈕即可:

修改數(shù)據(jù)結(jié)構(gòu)

修改數(shù)據(jù)結(jié)構(gòu)后,所有引用了該數(shù)據(jù)結(jié)構(gòu)的API均會發(fā)生改變,因此數(shù)據(jù)結(jié)構(gòu)可以復(fù)用并減少編寫API文檔的工作量。

進入 數(shù)據(jù)結(jié)構(gòu)管理 頁面,點擊相應(yīng)數(shù)據(jù)結(jié)構(gòu)的 修改 按鈕即可:

刪除數(shù)據(jù)結(jié)構(gòu)

刪除數(shù)據(jù)結(jié)構(gòu)前,系統(tǒng)會檢測當前數(shù)據(jù)結(jié)構(gòu)是否被API引用,如果數(shù)據(jù)結(jié)構(gòu)被API引用,則必須先刪除引用或者刪除API,否則無法刪除數(shù)據(jù)結(jié)構(gòu)。

進入 數(shù)據(jù)結(jié)構(gòu)管理 頁面,點擊數(shù)據(jù)結(jié)構(gòu)的 刪除 按鈕即可:

將數(shù)據(jù)結(jié)構(gòu)作為參數(shù)類型在API中引用

數(shù)據(jù)結(jié)構(gòu)僅可以用于API文檔中,API測試以及API自動化測試均無法使用數(shù)據(jù)結(jié)構(gòu)。

當我們需要在API文檔中快速引用某一個數(shù)據(jù)結(jié)構(gòu)時,我們在相應(yīng)的參數(shù)類型下拉框中可以選擇我們已經(jīng)創(chuàng)建好的數(shù)據(jù)結(jié)構(gòu):

在API詳情頁查看自定義數(shù)據(jù)結(jié)構(gòu)(參數(shù)類型)

自定義數(shù)據(jù)結(jié)構(gòu)在列表中會顯示藍色文字,點擊之后會彈窗顯示數(shù)據(jù)結(jié)構(gòu)的詳情:


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號