Export API
Last updated
Was this helpful?
Last updated
Was this helpful?
An API is available to allow exporting information from Cover Reports. This is a read only REST API that returns information in a JSON format. This API is provided to allow external systems to integrate with Cover Reports, for example, to download coverage statistics and incorporate them with other information within your organisation.
The available endpoints are specified in live documentation deployed within Cover Reports itself. To view this, navigate to/swagger-ui/index.html in Cover Reports, for example http://cover-reports.mycompany.com:8080/swagger-ui/index.html
This page reflects the capabilities of the installed Cover Reports.
Additionally, it is possible to send requests to the API using this page. This can be useful when exploring the API to understand how it works.
By default, any Diffblue Cover user can access the Cover Reports export API. However, you may want to restrict and/or secure access using API authentication. For example, you may want to restrict access to specific systems only. For more information see Configuration options.
Each release of Cover Reports may change the API. When changes are made that may break existing installations that have come to rely on the API, a new version will be set in the API URL. Existing systems will continue to work using the previous URLs, while new integrations can benefit from the improved API.
At this point, the previous API will be deprecated in favour of the new one. This will provide a short transition period to allow installations to adjust to use the new API.
Only 2 versions of the API will be supported at any time. Therefore, when an API is deprecated, it is important to migrate to the new API as soon as possible to ensure a continuous upgrade path.
