kintone OpenAPI Spec
kintone OpenAPI Specとは
kintone OpenAPI Specは、kintone REST APIのインターフェースを、OpenAPI Specification(OAS)にしたがって記述したものです。
公開しているファイルは、OpenAPI v3.0.3です。
仕様の詳細は、次のページを参照してください。
GitHub
https://github.com/kintone/openapi-spec
ライセンス
OpenAPI Specをツールに取り込んだり、クライアントを生成したりするときに、ライセンス表記を成果物へ引き継ぐ必要はありません。
ユースケース
OpenAPI Specは、次のようなユースケースで利用できます。
APIクライアントを生成する
kintone OpenAPI Specを用いることで、SDKが提供されていないプログラミング言語からでも、kintone REST APIを利用しやすくなります。
OpenAPI Generator
や
Swagger Codegen
などのコード生成ツールにより、APIクライアントを自動生成できるためです。
cybozu developer networkでは、次のSDKも提供しています。
APIを手軽に試す
OpenAPI SpecをPostmanなどのツールに取り込むと、画面上でAPIを手軽に実行できます。
Postmanの基本的な使い方は、次の記事も参照してください。
kintone REST APIをPostmanで実行してみよう
外部サービスや生成AIと連携する
OpenAPI Specは、外部サービスや生成AIにAPIの呼び出し方を伝える入力としても使えます。
エンドポイント、パラメーター、リクエストとレスポンスの構造、認証方式を記述することで、kintoneと連携できます。
警告
外部サービスや生成AIが対応しているOpenAPIのバージョンを確認してください。
公開しているファイルは、OpenAPI v3.0.3です。
利用上の注意
OpenAPI Specを利用するときは、次の点に注意してください。
- サーバーURLのサブドメインは、自身のkintoneのサブドメインへ書き換えてください。
- 対象は、 アップデートオプション をすべてオフにした状態のkintone REST APIです。
- 先行提供中のAPIや、APIラボのAPIは含みません。
- ユーザー、組織、グループを扱うUser APIは含みません。
- ゲストスペース向けのパス(
/k/guest/{guestSpaceId}/v1/...)も含みます。
