當(dāng)前,作為大部分移動(dòng)app和云服務(wù)后臺(tái)之間的標(biāo)準(zhǔn)連接方式,REST API已經(jīng)得到了絕大部分開發(fā)者的認(rèn)可和廣泛的應(yīng)用。近年來(lái),在新興API經(jīng)濟(jì)模式逐漸興起,許多廠商紛紛將自己的后臺(tái)業(yè)務(wù)能力作為REST API開放出來(lái),給更廣泛的第三方開發(fā)者使用。
但是,管理REST API并非是一件容易的工作。由于缺乏有效的接口數(shù)據(jù)schema約束,加上設(shè)計(jì)REST API時(shí)resource endpoint的安排,以及發(fā)送http請(qǐng)求的方式又都五花八門,REST API開發(fā)完成后,大多數(shù)情況下API開發(fā)者仍然需要手動(dòng)書寫API文檔,讓用戶能按照文檔的說(shuō)明接入。并且在API發(fā)生變化時(shí)需要重寫文檔,這個(gè)過(guò)程費(fèi)時(shí)費(fèi)力而且容易出錯(cuò)。比如,一個(gè)REST API文檔最少必須列明以下的基本信息:
* API的名稱
* API所在的URL資源路徑