EN JP CN

Klocwork Code Review Web API クックブック

Klocwork Code Review Web API クックブック

Code Review Web API は、管理者に Klocwork データベースに対するスクリプト可能なインターフェイスを提供します。API を使用すると、タグの割り当て、一覧表示、削除、名前変更、および割り当て解除や、検索クエリの生成を行うことができます。

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

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

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

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

出力は JSON レコード形式で、1 行ごとに 1 つの有効な JSON レコードで構成されます。API によって複数行が返される場合、JSON の各行を別々に処理するか、またはスクリプトを作成して行を結合する必要があります。これは、処理をする前に応答全体を 1 つの文字列に読み取らずに、大量の結果を処理できるようにするためです。JSON の詳細については、http://www.json.org/ を参照してください。

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