SonarQube es la herramienta más poderosa para el análisis del código. Te permite identificar problemas, te sugiere cómo puedes resolverlos y, sobre todo, te ayuda a mantener la calidad y seguridad de tus proyectos. A través de su API, los usuarios pueden realizar peticiones e integrar su instancia en su flujo de trabajo, más allá de utilizar su interfaz gráfica. En este artículo te mostramos una guía para que utilices la API de SonarQube correctamente.
¿Qué es la API de SonarQube?
La API de SonarQube permite a los usuarios comunicarse con su instancia. Gracias a la API, los desarrolladores pueden integrar SonarQube en sus flujos de trabajo y obtener la información que necesitan. Este mecanismo es muy útil, ya que permite extraer información de interés sin la necesidad de interactuar con la interfaz de usuario.
¿Cómo utilizar la API de SonarQube?
Para utilizar la API de SonarQube tienes que hacer llamadas HTTP a los endpoints para que te devuelva la información que necesitas. Lo primero que tienes que hacer es obtener un token de autenticación para hacer peticiones a la API de SonarQube de forma segura. Aquí te dejamos los pasos para obtener este token.
1 - Accede a tu instancia de SonarQube logeándote con tu usuario.
2 - Accede a My Account -> Security.
3 - Escribe un nombre para tu token, selecciona el tipo y el tiempo de expiración.
4 - Copia tu token.
Con este token ya puedes realizar peticiones a la API de SonarQube. A continuación, te dejamos un ejemplo de petición para obtener una lista de proyectos de tu instancia de SonarQube:
curl -u <'tu_token'>: "http://
Aquí te dejamos un listado de endpoints útiles para realizar llamadas a la API de SonarQube:
-
Obtener un listado de hotspots
GET api/hotspots/search -
Extraer un listado de issues
GET api/issues/search -
Conocer si un proyecto tiene código IA o no
GET api/projects/get_contains_ai_code -
Listado de proyectos relacionado con su Quality Gate
GET api/qualityprofiles/projects -
Actualizar una rama en una aplicación de una aplicación en concreto
POST api/applications/update_branchs
En este enlace tienes el listado completo de servicios que ofrece la API de SonarQube Server.
Ejemplos de solicitud a la API de SonarQube
Nuestro Sonar Bug Hunter, Mario Bastardo ha preparado dos videos en los que te enseña a realizar dos tipos distintos de llamadas a la API.
En este primer video, Mario te enseña a ejecutar una llamada a la API de SonarQube para consultar el estado de la instancia:
En este segundo video, muestra un tutorial en el que aprenderás a realizar una llamada a la API de SonarQube Cloud para obtener una lista de servicios disponibles:
Hasta aquí este artículo de hoy. Recuerda que si quieres ampliar la información sobre licencias o servicios de SonarQube Server o SonarQube Cloud, puedes ponerte en contacto con nosotros a través de este enlace. Y si quieres ver más tutoriales sobre las herramientas de SonarQube, puedes suscribirte a nuestro canal de YouTube.