kintone OpenAPI Spec

目錄

什麼是kintone OpenAPI Spec

kintone OpenAPI Spec是依照OpenAPI Specification(OAS)描述kintone REST API介面的規格。

公開的檔案為OpenAPI v3.0.3。
有關規格的詳細資訊,請參閱以下頁面。

OpenAPI Specification v3.0.3 (External link)

GitHub

https://github.com/kintone/openapi-spec (External link)

授權

MIT No Attribution(MIT-0) (External link)

將OpenAPI Spec匯入工具或生成用戶端時,無需在成果物中保留授權標示。

使用案例

OpenAPI Spec可用於以下使用案例。

生成API用戶端

透過使用kintone OpenAPI Spec,即使是沒有提供SDK的程式語言,也能更輕鬆地使用kintone REST API。
這是因為可以透過 OpenAPI Generator (External link) 、 Swagger Codegen (External link) 等程式碼生成工具,自動生成API用戶端。

information

cybozu developer network還提供以下SDK。

輕鬆測試API

將OpenAPI Spec匯入Postman等工具後,就能在畫面上輕鬆執行API。
有關Postman的基本使用方法,也請參閱以下文章。

在Postman中執行kintone REST API (日語)

與外部服務或生成式AI整合

OpenAPI Spec也可作為向外部服務或生成式AI說明API呼叫方式的輸入使用。
透過描述端點、參數、請求與回應的結構以及認證方式,即可與kintone整合。

caution
警告

請確認外部服務或生成式AI支援的OpenAPI版本。
公開的檔案為OpenAPI v3.0.3。

使用時的注意事項

使用OpenAPI Spec時,請注意以下事項。

  • 請將伺服器URL的子網域改為您自己的kintone子網域。
  • 對象為關閉所有 更新選項 (日語)的kintone REST API。
  • 不包含先行提供中的API及API實驗室的API。
  • 不包含處理使用者、組織、群組的User API。
  • 包含訪客空間專用的路徑(/k/guest/{guestSpaceId}/v1/...)。