數據模型
數據模型類似于編程語言中的數據結構，在API設計時主要應用于 “返回響應”和json/xml類型的“Body參數”。在設計API的請求體或響應內容時，開發(fā)者可直接引入公共的數據模型，實現數據結構的即時復用。此外，還提供在數據模型的文檔頁面直觀查看所有引用該模型的API及其它模型，從而加深了模塊間透明度，促進了設計的一致性和維護的便利性。
公共響應
公共響應，默認遵循“application/json”格式，旨在提供統一且規(guī)范的返回結果。在設計API的響應體時，開發(fā)者能夠引用已有的公共響應模板，以此加快開發(fā)進程并確保響應信息的標準化。
每項公共響應的文檔頁面均詳盡展示了所有引用該響應的API列表，便于維護與升級，從而提升了整個API生態(tài)的協同效率與信息管理的清晰度。
公共參數
在API設計環(huán)節(jié)中，公共請求參數扮演著基礎而靈活的角色，支持配置于“query”（查詢字符串）、“path”（路徑）或“header”（頭部）等多個位置，以適應多樣化的接口需求。開發(fā)者能夠直接調用預定義的公共參數，有效加速了請求參數的標準化構建過程。此外，每個公共參數的文檔頁面均匯總了所有引用該參數的API列表，極大增強了參數管理和接口文檔的透明度，便于開發(fā)者進行高效維護與協同作業(yè)。
公共請求體
在接口設計中，公共請求體默認“application/json”格式。開發(fā)者能夠便捷地復用已定義的公共請求體，直接應用于API的Body部分，顯著提升了開發(fā)效率與數據結構的一致性。且公共請求體文檔頁面也詳盡展示了所有引用該請求體的API，便于后期維護。
公共示例
公共示例允許在API的請求體實例與響應結果示例中靈活引用，確保了示例數據的統一性和準確性。在公共示例文檔頁面還清晰羅列了所有引用該示例的API，便于后期維護。
安全模型
安全模型提供“http”、“apikey”、“oauth2”、“openIdConnect”四種類型。選擇不同類型的安全模型后，需要在方案內容中填寫必要的配置信息，然后用于API設計中“安全方案”的引用。此外，每個安全模型的文檔頁面展示了所有引用該模型的API清單，便于后期維護。
公共響應頭
公共響應頭旨在簡化并標準化API“返回響應”中的頭部信息配置。API設計過程中，開發(fā)者能夠直接引用已定義的公共響應頭至響應頭設置中，促進了響應格式的一致性和管理的高效性。此外，每個公共響應頭的文檔頁面都詳細列出了所有引用該響應頭的API，便于后期維護。