微軟宣佈在Azure API管理中預覽OpenAPI規範V3

最近,微軟宣佈在Azure API管理中支持OpenAPI規範V3,他們的服務允許創建、發佈、監控和維護API。OpenAPI規範的使用是通過 OpenAPI .NET SDK完成的,並支持從它們的實現中抽象出API定義。

OpenAPI規範(以前稱爲Swagger)提供了以獨立於語言的方式描述RESTful Web服務的方法。隨着OpenAPI的廣泛採用,已經形成了一個多樣化的生態系統,我們可以使用各種工具來設計、記錄、構建、測試和實現治理。該規範受Linux基金會下屬的OpenAPI Initiative監督,並有各種各樣的組織推動其開發,包括SmartBear、微軟和WSO2等公司。任何人都可以在OpenAPI Initiative的GitHub存儲庫上跟蹤甚至參與規範的開發。

根據微軟Azure MVP和Azure架構師Tom Kerkhove的說法,在向消費者公開API時,規範扮演着重要的角色。

API必須乾淨整潔且文檔良好。這讓你的消費者可以知道你提供了哪些功能、它們的用途以及可以有怎樣的期望。這就是OpenAPI規範(又名Swagger)的作用所在,它定義了應該如何在整個行業中定義API,而不管其背後的技術是什麼。

規範的版本3帶來了一些變化,現在Azure API管理也已經支持這些變化。例如,這個新版本引入了一個包含諸如消息頭、鏈接和回調等組件的全新體系結構,在定義中採用了更加模塊化的方法,RestCase首席執行官Guy Levin對此進行了描述。

3.0版本的API規範格式採用一種更加模塊化且可重用的方法定義API表面(surface area),提供了更強大的請求和響應模型描述能力和靈活性,並詳細描述了構成API用法的通用組件,如底層數據模式和安全定義。

引入的另一個選項是在操作中包含callbacks,這意味着現在可以定義webhook。最後,鏈接(linking)使我們可以定義API的不同路徑之間的關係,提供了屬性擴展能力。

image

隨着公告發布,現在已經可以在Azure API管理中導入OpenAPI V3定義,儘管有一些限制。目前,既可以通過門戶,也可以通過REST API。接着,導出OpenAPI描述的功能也已經可用,可以通過開發者門戶,或使用另一個REST API調用。

image

最終,這些功能將正式發佈,使用PowerShell SDK進行定義的導入和導出也會成爲可能。

查看英文原文:

https://www.infoq.com/news/2019/01/openapi-v3-support-azure-apim

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章