OpenAPI-SpecificationREST API 標(biāo)準(zhǔn)接口

OpenAPI Specification 的目標(biāo)是為 REST API 定義一個(gè)標(biāo)準(zhǔn)的、與語(yǔ)言無(wú)關(guān)的接口，允許人和計(jì)算機(jī)在不訪問(wèn)源代碼、文檔或通過(guò)網(wǎng)絡(luò)的情況下發(fā)現(xiàn)和理解服務(wù)的功能。 通過(guò) OpenAPI 的正確定義，消費(fèi)者可以用最簡(jiǎn)答的方式理解遠(yuǎn)程服務(wù)并與其交互，消除了調(diào)用服務(wù)時(shí)的猜測(cè)。

OpenAPI不需要重寫(xiě)現(xiàn)有的API。它不需要將任何軟件綁定到服務(wù)，所描述的服務(wù)甚至可能不是您的。然而，它要求在 OpenAPI Specification 的結(jié)構(gòu)中描述服務(wù)的能力。不是所有的服務(wù)都可以由 OpenAPI 描述 —— 此規(guī)范并不打算涵蓋 REST-ful API 的每一個(gè)可能的用例。 OpenAPI沒(méi)有規(guī)定諸如設(shè)計(jì)優(yōu)先或代碼優(yōu)先的開(kāi)發(fā)過(guò)程。它通過(guò)與 REST API 建立明確的交互來(lái)促進(jìn)這兩種技術(shù)之一。