I would like to know if there is an OpenAPI(3.x) definition or Swagger(2.X) for the Sonar Web API?

Hello All
I’m looking for the openAPI or swagger definition of the Sonarqube Web API.

2 Likes

Hello! There is not, but you can always find the documentation for the Web API linked in the footer of your instance.

It’d be nice to have an OpenAPI specification so it can be consumed programmatically. For example, we are building clients that consume the API, unit tests of that client are mocking Sonarqube web API. If the openapi spec was available we could automatically validate our mocks are correct (using tools like swagger-mock-validator)

1 Like