Klocwork Web API クックブック

Klocwork Web API は、管理者に Klocwork データベースに対するスクリプト可能なインターフェイスを提供します。検出された指摘やメトリックスに関する例は、指摘とメトリック API の例を参照してください。アクセス制御に関する例は、API アクセス制御の例を参照してください。

初期設定では、Web API へのアクセス権はプロジェクトルート管理者およびプロジェクト管理者に付与されています。Klocwork Static Code Analysis の[役割]タブ または、アクセス制御 APIにより、他のユーザーに Web API アクセス権限を付与することができます。

API を使用すると、たとえば、検出された指摘のリストを生成してビューを作成できます。

API は、HTTP 要求を下記の URL に投稿するだけで簡単に使用できます。

http(s)://<klocwork_server_host>:<klocwork_server_port>/review/api

Klocwork サーバーのセキュア接続が構成されている場合は、https:// を使用します。

出力は JSON レコードの形式です。JSON の詳細については、http://www.json.org/ を参照してください。

ユーティリティによる HTTP 要求は、curl や使い慣れたスクリプト言語を使用する場合と同様に簡単です。Curl を使用すると、JSON 出力を読み取ることができますが、出力をさらに処理する場合は、Python や Ruby などのスクリプト言語を使用する必要があります。POST HTTP 要求の送信をサポートし、JSON 出力を処理する言語なら、どれでもスクリプトを記述できます。この記事ではすべての例で curl を使用しています。