歡迎來到新北市政府 OpenAPI 功能,本平臺透過統一的介面與標準,以Swagger 套件工具呈現,提供好懂、簡易操作的使用者介面。
【Swagger】 Swagger 是一套開源工具,專門用來撰寫基於 REST 的 API,幫助工程師更輕鬆地建立美觀、安全、高效且可擴充的 API。
【OpenAPI】 OpenAPI 文件是 API 的完整規格說明書,可清楚描述 API 可執行的操作、請求參數、回應格式、驗證方式等。 OpenAPI 是全球通用且廣泛採用的 RESTful API 標準,開發者只要遵循該規範,就能建立可被世界各地系統一致理解與使用的 API,同時確保在安全性、錯誤處理、版本控制等方面符合最佳實務。
【Swagger 與 OpenAPI 的關係】 OpenAPI 是一套規範;Swagger 則是實現這套規範的工具。