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

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Published
October 2021
Language
English (United States)
Last Update
2021-10-14
dita:mapPath
cai1626458602965.ditamap
dita:ditavalPath
cai1626458602965.ditaval
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem
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.