Hub 2020.1 Help

OpenAPI Specification (OAS)

We're using Swagger to generate and publish an OpenAPI Specification (OAS) document for the Hub 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 Hub.

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:

<Hub Service URL>/api/rest/openapi.json

The <Hub Service URL> is the base URL of the Hub service in your network environment.

For example, your company has a proprietary domain with the address www.mycompany.com. You can configure Hub to be accessible from an address like www.mycompany.com/hub or hub.mycompany.com.

In either case, all you need to do to access the OpenAPI Specification is add /api/rest/openapi.json to whichever address is set up as the base URL for your Hub service.

Last modified: 25 March 2020