Getting Started With Web API

SonarQube
1
  • Community Edition
  • Version 7.6 (build 21501)
  • LGPL v3

New to SonarQube, not to accessing API’s via C#. Having a frustrating start.

Via Web API, trying to access values from projects?sort=-analysis_date, dashboard?id=LBCR_Analysis, component_measures?id=LBCR_Analysis

I dont know what a component is, so I try:

curl http://uscfu1sonar:9000/api/components/search?qualifiers=TRK

I get:

{“paging”:{“pageIndex”:1,“pageSize”:100,“total”:2},“components”:[{“organization”:“default-organization”,“id”:“AWnEjHRAt8fZ7XjiwTPg”,“key”:“CSTS_Analysis”,“name”:“CSTS_Analysis”,“qualifier”:“TRK”,“project”:“CSTS_Analysis”},{“organization”:“default-organization”,“id”:“AWnK5Q6ot8fZ7XjiwTPn”,“key”:“LBCR_Analysis”,“name”:“LBCR_Analysis”,“qualifier”:“TRK”,“project”:“LBCR_Analysis”}]}

Nothing says ‘component=’, so I eventually brute force:

curl http://uscfu1sonar:9000/api/components/show?component=LBCR_Analysis

I get:

{“component”:{“organization”:“default-organization”,“id”:“AWnK5Q6ot8fZ7XjiwTPn”,“key”:“LBCR_Analysis”,“name”:“LBCR_Analysis”,“qualifier”:“TRK”,“analysisDate”:“2019-04-01T10:27:46-0400”,“tags”:,“visibility”:“public”,“version”:“not provided”},“ancestors”:}

Okaaay, so I try:

curl http://uscfu1sonar:9000/api/measures/component?component=LBCR_Analysis&metricKeys=code_smells,sqale_index,sqale_debt_ratio

I get:

{“errors”:[{“msg”:“The ‘metricKeys’ parameter is missing”}]}‘metricKeys’ is not recognized as an internal or external command,
operable program or batch file.

Huh??

Lots of old code samples, deprecated parameters and URLs. Confusing. Welcome ideas for that error …

Is there a newbie, step-by-step walk-through for accessing measures or metrics or component_measures or whatever name is now valid for these numbers?

Thank you!

3

Multiple query parameters, need to wrap the url with single quotes. :slight_smile: Not a SonarQube thing, but a curl thing.

curl 'http://uscfu1sonar:9000/api/measures/component?component=LBCR_Analysis&metricKeys=code_smells,sqale_index,sqale_debt_ratio'

5

Thank you! Mine required double quotes for some reason.

curl “http://uscfu1sonar:9000/api/measures/component?component=LBCR_Analysis&metricKeys=ncloc,complexity,violations”