Support for Swagger OpenAPI | Teradata Data Mover - 17.10 - Swagger User Interface - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)
Data Mover supports the Swagger documentation and user interface. The Swagger interface provides details about RESTful API specification and you can test REST APIs using Swagger. Once enabled, the Swagger interface can be constructed as in the following example:
https://dm_host:1443/datamover/swagger-ui.html
Use the following commands to enable or disable Swagger:
Option Description
Enable Set swagger.ui.enabled=true in tdmrest.properties.
Disable Set swagger.ui.enabled=false in tdmrest.properties.
You must restart the REST service after enabling or disabling Swagger.