API design is prone to errors, and it’s extremely difficult and time-consuming to spot and rectify mistakes when modeling APIs. More information here: https://swagger.io
Swagger built for designing APIs with the OpenAPI Specification (OAS), and has continued to meet the needs of developers building APIs with OAS. Swagger validates our design in real-time, checks for OAS compliancy, and provides visual feedback on the go.
How to use Rest API
End points are available on /v2/swagger/editor.spr url, without any authentication, please note that in order to use a rest API end point your user need to have 'api_permission'.
Please visit <site url>/v2/swagger/editor.spr url for a built in API tester.
First you need to authenticate to use any API endpoint, click on the "Authorize" button and use you username and password
After you authenticated, you can use any API endpoints, to see the avalaible API endpoints, please click on the group name
In order to execute an API, please click on the "Try it out" button
Set a ID of your tracker item and click on the "Execute" button
After the execution, you should see the a Curl example of your request, and the result itself
In case of the ID of tracker item is not valid, you should see a 404 error code and an error message in the response
Examples are also provided for complex API
How to generate a swagger client
Register on swaggerHub
You can register on swaggerHub and import our swagger.json, please use the /v2/swagger.json to download it.