數(shù)據(jù)模型類似于編程語言中的數(shù)據(jù)結(jié)構(gòu)，在API設(shè)計(jì)時(shí)主要應(yīng)用于 “返回響應(yīng)”和json/xml類型的“Body參數(shù)”。在設(shè)計(jì)API的請求體或響應(yīng)內(nèi)容時(shí)，開發(fā)者可直接引入公共的數(shù)據(jù)模型，實(shí)現(xiàn)數(shù)據(jù)結(jié)構(gòu)的即時(shí)復(fù)用。此外，還提供在數(shù)據(jù)模型的文檔頁面直觀查看所有引用該模型的API及其它模型，從而加深了模塊間透明度，促進(jìn)了設(shè)計(jì)的一致性和維護(hù)的便利性。

公共響應(yīng)，默認(rèn)遵循“application/json”格式，旨在提供統(tǒng)一且規(guī)范的返回結(jié)果。在設(shè)計(jì)API的響應(yīng)體時(shí)，開發(fā)者能夠引用已有的公共響應(yīng)模板，以此加快開發(fā)進(jìn)程并確保響應(yīng)信息的標(biāo)準(zhǔn)化。

每項(xiàng)公共響應(yīng)的文檔頁面均詳盡展示了所有引用該響應(yīng)的API列表，便于維護(hù)與升級，從而提升了整個(gè)API生態(tài)的協(xié)同效率與信息管理的清晰度。

在API設(shè)計(jì)環(huán)節(jié)中，公共請求參數(shù)扮演著基礎(chǔ)而靈活的角色，支持配置于“query”（查詢字符串）、“path”（路徑）或“header”（頭部）等多個(gè)位置，以適應(yīng)多樣化的接口需求。開發(fā)者能夠直接調(diào)用預(yù)定義的公共參數(shù)，有效加速了請求參數(shù)的標(biāo)準(zhǔn)化構(gòu)建過程。此外，每個(gè)公共參數(shù)的文檔頁面均匯總了所有引用該參數(shù)的API列表，極大增強(qiáng)了參數(shù)管理和接口文檔的透明度，便于開發(fā)者進(jìn)行高效維護(hù)與協(xié)同作業(yè)。

在接口設(shè)計(jì)中，公共請求體默認(rèn)“application/json”格式。開發(fā)者能夠便捷地復(fù)用已定義的公共請求體，直接應(yīng)用于API的Body部分，顯著提升了開發(fā)效率與數(shù)據(jù)結(jié)構(gòu)的一致性。且公共請求體文檔頁面也詳盡展示了所有引用該請求體的API，便于后期維護(hù)。

公共示例允許在API的請求體實(shí)例與響應(yīng)結(jié)果示例中靈活引用，確保了示例數(shù)據(jù)的統(tǒng)一性和準(zhǔn)確性。在公共示例文檔頁面還清晰羅列了所有引用該示例的API，便于后期維護(hù)。

安全模型提供“http”、“apikey”、“oauth2”、“openIdConnect”四種類型。選擇不同類型的安全模型后，需要在方案內(nèi)容中填寫必要的配置信息，然后用于API設(shè)計(jì)中“安全方案”的引用。此外，每個(gè)安全模型的文檔頁面展示了所有引用該模型的API清單，便于后期維護(hù)。

公共響應(yīng)頭旨在簡化并標(biāo)準(zhǔn)化API“返回響應(yīng)”中的頭部信息配置。API設(shè)計(jì)過程中，開發(fā)者能夠直接引用已定義的公共響應(yīng)頭至響應(yīng)頭設(shè)置中，促進(jìn)了響應(yīng)格式的一致性和管理的高效性。此外，每個(gè)公共響應(yīng)頭的文檔頁面都詳細(xì)列出了所有引用該響應(yīng)頭的API，便于后期維護(hù)。