如何使用SonarQube网络API？

以前，我问过how to export custom data from SonarQube Database，Sonar团队建议我应该使用Web API。如何使用SonarQube网络API？

经过一番研究，我仍然为如何使用Web API而苦苦挣扎。（我对Web API的工作原理非常陌生）

看完这个post后，我意识到我可以使用Java代码来实现这一点。但是（我已经通过了如何使用Apache HTTP客户端刚刚过去），运行后

HttpGet httpGet = new HttpGet("http://localhost:9000/api/issues?metrics=lines");（从后复制）

我：

HTTP/1.1 404 {"errors":[{"msg":"Unknown url : /api/issues"}]}

我改变这一行后于：

HttpGet httpGet = new HttpGet("http://localhost:9000/project/issues?facetMode=effort&id=project%3Atesting&resolved=false&types=CODE_SMELL");

我：

HTTP/1.1 200 <!DOCTYPE html><html lang="en"><head><meta http-equiv="content-type" content="text/html; charset=UTF-8" charset="UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"><link rel="apple-touch-icon" href="/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="57x57" href="/apple-touch-icon-57x57.png"><link rel="apple-touch-icon" sizes="60x60" href="/apple-touch-icon-60x60.png"><link rel="apple-touch-icon" sizes="72x72" href="/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="76x76" href="/apple-touch-icon-76x76.png"><link rel="apple-touch-icon" sizes="114x114" href="/apple-touch-icon-114x114.png"><link rel="apple-touch-icon" sizes="120x120" href="/apple-touch-icon-120x120.png"><link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon-144x144.png"><link rel="apple-touch-icon" sizes="152x152" href="/apple-touch-icon-152x152.png"><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon-180x180.png"><link rel="icon" type="image/x-icon" href="/favicon.ico"><meta name="application-name" content="SonarQube"/><meta name="msapplication-TileColor" content="#FFFFFF"/><meta name="msapplication-TileImage" content="/mstile-512x512.png"/><link href="/css/sonar.bf342fee.css" rel="stylesheet"><title>SonarQube</title></head><body><div id="content"><div class="global-loading"><i class="spinner global-loading-spinner"></i> <span class="global-loading-text">Loading...</span></div></div><script>window.baseUrl=""</script><script src="/js/vendor.0ba4fd94.js"></script><script src="/js/app.bf342fee.js"></script></body></html>

这不是我所期望的。

我想知道什么是正确的方式来使用Web API？例如，如果我想让代码闻起来像一个项目。代码应该如何在Java中？

这里是我使用的时刻代码：

import java.io.IOException; 
import org.apache.http.HttpEntity; 
import org.apache.http.client.ClientProtocolException; 
import org.apache.http.client.methods.CloseableHttpResponse; 
import org.apache.http.client.methods.HttpGet; 
import org.apache.http.impl.client.CloseableHttpClient; 
import org.apache.http.impl.client.HttpClients; 
import org.apache.http.util.EntityUtils; 

public class Test { 
    public static void main(String[] args) throws ClientProtocolException, IOException { 

     //HttpGet httpGet = new HttpGet("http://localhost:9000/api/issues?metrics=lines"); 
     HttpGet httpGet = new HttpGet("http://localhost:9000/project/issues?facetMode=effort&id=project%3Atesting&resolved=false&types=CODE_SMELL"); 

     try(CloseableHttpClient httpClient = HttpClients.createDefault(); 
      CloseableHttpResponse response = httpClient.execute(httpGet);) { 
      System.out.println(response.getStatusLine()); 
      HttpEntity entity = response.getEntity(); 
      System.out.println(EntityUtils.toString(entity)); 
     } 
    } 
}

欣赏任何帮助或指导！

来源

2017-09-20 MaXon

根据SonarQube文档，SonarQube web API位于/api上下文路径下，以及部分和操作（您似乎缺少）。

例如，要搜索在端口9000上运行的本地主机上的问题，请发送GET至http://localhost:9000/api/issues/search?pageSize=500&componentKeys=YOUR_COMPONENT并解析JSON响应。

您可能还需要提供授权，该授权既可以作为BASIC用户名密码组合发送，也可以通过Web客户端检索到访问令牌。

来源

2017-09-20 06:40:39

非常感谢你，这就是我需要的！ – MaXon

你能否解释我应该在'？'之后放置什么？标记？在你的情况，你把pageSize = 500和componentKeys = YOUR_COMPONENT。我发现componentKeys是'issues/search'下的参数之一。那么pageSize呢？我在哪里可以找到这种参数？ – MaXon

'pageSize'只是控制你回来的结果数量，500是最大值。已弃用的文档列出它们，但是如果它们被删除，我会感到惊讶：https://docs.sonarqube.org/pages/viewpage.action?pageId=2392181 –

如何使用SonarQube网络API？

回答

相关问题