高達(dá)55%的調(diào)查受訪者使用OpenAPI版本,而RAML和API藍(lán)圖為7%。

為什么OpenAPI贏得了戰(zhàn)爭(zhēng)?

OpenAPI(當(dāng)時(shí)名為Swagger)首先上市,但還有其他一些關(guān)鍵因素有助于通過(guò)口碑迅速傳播:

OpenAPI是更好的格式嗎?

毫無(wú)疑問(wèn),OpenAPI是使用最廣泛的標(biāo)準(zhǔn)。然而,RAML和API藍(lán)圖都解決了合法問(wèn)題,通常以更有針對(duì)性的方式。

例如,考慮OAS和RAML之間的差異。2017年,MuleSoft表示:“RAML已成為建模API規(guī)范的主要方式,[OpenAPI]已成為描述API的最常見(jiàn)格式?!?/p>

使用這些術(shù)語(yǔ)時(shí)有相似之處和模糊之處。如果我們要求ChatGPT告訴我們“建?!焙汀懊枋觥盇PI之間的區(qū)別,它告訴我們,“API建模是指設(shè)計(jì)和定義API結(jié)構(gòu)的過(guò)程,包括其端點(diǎn)、請(qǐng)求/響應(yīng)格式和錯(cuò)誤處理。它涉及創(chuàng)建API功能和行為的藍(lán)圖。另一方面,API描述是指記錄API的行為,包括其目的、使用和參考信息,如可用的端點(diǎn)、請(qǐng)求/響應(yīng)格式、身份驗(yàn)證方法和錯(cuò)誤代碼。API描述的目的是為開(kāi)發(fā)人員提供有效使用API所需的所有信息?!?/p>

總之,API建模是關(guān)于設(shè)計(jì)API,而API描述是關(guān)于記錄它。

ChatGPT,由OpenAI開(kāi)發(fā)的聊天機(jī)器人

換句話說(shuō),開(kāi)發(fā) RAML 是為了對(duì) API 進(jìn)行建模和設(shè)計(jì),而開(kāi)發(fā) Swagger 是為了描述和記錄 API。在 API 生命周期的初期,當(dāng) API 生產(chǎn)者決定 API 應(yīng)該是什么時(shí),他們可能會(huì)傾向于使用 RAML。API 生產(chǎn)者可能會(huì)在設(shè)計(jì)完成后生成 Swagger 文件,以增強(qiáng) API 消費(fèi)者的開(kāi)發(fā)體驗(yàn)。無(wú)論意圖如何,這兩種格式都可用于在整個(gè) API 生命周期中對(duì) API 進(jìn)行建?;蛎枋觥?/p>

事實(shí)上,隨著 OpenAPI 的廣泛應(yīng)用,API 生產(chǎn)者現(xiàn)在使用這種格式來(lái)設(shè)計(jì)和記錄他們的 API,我們也看到了一些 API 優(yōu)先的實(shí)施方案。與其他替代方案相比,API 消費(fèi)者對(duì) OpenAPI 也更為熟悉。因此,爭(zhēng)論每種標(biāo)準(zhǔn)的優(yōu)劣已經(jīng)沒(méi)有意義,因?yàn)?OpenAPI 已經(jīng)贏得了這場(chǎng)戰(zhàn)爭(zhēng)。

當(dāng)你考慮OpenAPI提供的使用程度和互操作性時(shí),爭(zhēng)論每種格式的優(yōu)點(diǎn)是毫無(wú)意義的。

Kevin Swiber,Postman的OpenAPI倡議外聯(lián)和API生命周期集成專(zhuān)家

如果您是MuleSoft開(kāi)發(fā)人員,您仍然可以選擇使用RAML和OpenAPI。如果您是Apiary開(kāi)發(fā)人員,您也可以選擇使用API Blueprint和OpenAPI。然而,OpenAPI擁有更多的采用率、更豐富的生態(tài)系統(tǒng)和更多的社區(qū)支持。

參考資料

英文原文: RAML and API Blueprint: where are they now?,作者: Joyce

上一篇:

輕量級(jí)代理對(duì)API管理的好處

下一篇:

什么是 API 中的深度限制?
#你可能也喜歡這些API文章!

我們有何不同?

API服務(wù)商零注冊(cè)

多API并行試用

數(shù)據(jù)驅(qū)動(dòng)選型,提升決策效率

查看全部API→
??

熱門(mén)場(chǎng)景實(shí)測(cè),選對(duì)API

#AI文本生成大模型API

對(duì)比大模型API的內(nèi)容創(chuàng)意新穎性、情感共鳴力、商業(yè)轉(zhuǎn)化潛力

25個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)

#AI深度推理大模型API

對(duì)比大模型API的邏輯推理準(zhǔn)確性、分析深度、可視化建議合理性

10個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)