Export Sonar Regeln mit Beschreibung zu übertreffen

Question

Ich versuche einen Weg zu finden, eine Liste aller Sonarqube Regeln von einem bestimmten Profil mit Beschreibungen zu erhalten und es als Excel, CSV oder XML zu exportieren. Ich kann eine Liste nach XML exportieren und nach Excel konvertieren, indem ich die Permalinks-Option unter Qualitätsprofile benutze, aber dies liefert nur Details über den Präferenz-, Schlüssel-, Sprach- und Profilnamen jeder Regel und nichts weiter wie die Beschreibung der Regel .

fand ich die folgende Frage auf dem Forum, das die Schritte beschreibt die XML-Datei mit den Details aufgelistet zum Download, aber die Beschreibung nicht als

erforderlich

Export list of coding rules from Sonarqube

ich auch diese Frage gefunden, welche die gleiche fragt auch Frage, wie Beschreibungen auf jede Regel zu erhalten, konnte aber nicht die Details erhalten erforderlich

sonar quality profile rule export with descrption

konnte ich die comman laufen d im vorherigen Link bereitgestellt, um einige erforderliche Ergebnisse durch Verweisen auf den Repository-Schlüssel und Schlüsselname von der Xml unter Permalinks im Abschnitt Qualitätsprofile erhalten

curl -X GET -v -u admin: admin "http://[Sonarservername]:[port]/api/rules/show?key=[repositorykey]:[key_name]" --output-Datei .xml

Dieser Befehl liefert das gewünschte Ergebnis (Beschreibung der Regel), aber es ist erforderlich, den Repository-Schlüssel adn Schlüsselname für jede Regel zu ändern. Dies ist nicht möglich, da ich die Beschreibung für über 550 Regeln benötigen

Was ist erforderlich, um Beschreibung/Regel Beschreibung Text zu bekommen?

Bitte helfen.

Answer 1

Wenn mein Verständnis richtig ist, sollte der/api/rules/search-Webservice Ihre Bedürfnisse abdecken. Eine Liste der Java-Regeln finden Sie unter https://sonarcloud.io/api/rules/search?languages=java.

Die API unterstützt viele Parameter, die hier dokumentiert sind: https://sonarcloud.io/web_api/api/rules/search (Klicken Sie auf die Überschrift Parameter oberhalb der horizontalen Linie, um die Beschreibungen zu öffnen).

Zum Beispiel ermöglicht der Parameter rule_key die Suche nach einer bestimmten Regel. Um Informationen zur S2065-Regel zu finden (Felder in nicht serialisierbaren Klassen sollten nicht "vorübergehend" sein), können Sie Folgendes verwenden: https://sonarcloud.io/api/rules/search?rule_key=squid:S2065