OpenAPI Specification (OAS)
We're using Swagger to generate and publish an OpenAPI Specification (OAS) document for the YouTrack REST API. This richly annotated OAS 3.0 definition is produced in JSON format. This artifact is designed to be fed into interactive API consoles and used to build client libraries for developing external applications that integrate with YouTrack.
The OAS 3.0 definition is compatible with tools like Swagger, Open API Generator, and Postman. These tools give you the ability to work with the API in different ways:
Interact with the API in a sandbox UI that helps you understand how the API responds to different parameters and options.
View and test each resource before using it in your codebase.
Generate client libraries in your preferred programming language.
Accessing the OpenAPI Specification
The OAS 3.0 definition is published to the following web address:
The <YouTrack Service URL> is the base URL of the YouTrack service in your network environment or the base URL of your YouTrack Cloud. For more details about the base URL and the REST API URL, see REST API URL and Endpoints.
Below you can find examples of OAS definition URLs for different YouTrack setups:
YouTrack Service URL | OAS Definition URL |
|---|---|
https://www.example.com/youtrack | https://www.example.com/youtrack/api/openapi.json |
https://youtrack.example.com | https://youtrack.example.com/api/openapi.json |
YouTrack Service URL | OAS Definition URL |
|---|---|
https://example.youtrack.cloud | https://example.youtrack.cloud/api/openapi.json |
https://example.myjetbrains.com/youtrack | https://example.myjetbrains.com/youtrack/api/openapi.json |
In any case, all you need to do to access the OpenAPI Specification is add /api/openapi.json to the address that is set up as the base URL for your YouTrack.