Skip to content

What is Swagger?

Swagger is a set of open-source tools built around the OpenAPI Specification that can help you design, build, document and consume REST APIs. OpenAPI Specification is an API description format for REST APIs. An OpenAPI file will typically allow you to describe your entire API, including:

  • Available operations your API supports
  • Your API parameters and what it returns
  • Authentication methods
  • Contact information, license, terms of use and other information

Some of the featured Swagger tools are:

  • Swagger Editor - a browser-based editor where you can write OpenAPI definitions.
  • Swagger UI - renders OpenAPI definitions as interactive document.
  • Swagger Codegen - generates sever stubs and client libraries from OpenAPI definitions.

To find out more information about Swagger, see Swagger Documentation.



RTDIP REST API Endpoints

RTDIP REST API documentation is available in a number of formats, as described below.

rest

RTDIP REST APIs are built to OpenAPI standard 3.0.2. You can obtain the OpenAPI JSON schema at the following endpoint of your deployed APIs https://{domain name}/api/openapi.json

rest

It is recommended to review the Swagger documentation that can be found at the following endpoint of your deployed APIs https://{domain name}/docs for more information about the parameters and options for each API. It is also possible to try out each API from this link.

rest

Additionally, further information about each API can be found in Redoc format at the following endpoint of your deployed APIs https://{domain name}/redoc



← Previous Next →

Course Progress

  • Introduction
  • SDK
  • Power BI
  • APIs
    • Overview
    • Authentication
    • Swagger
    • Postman
    • Exercise
  • Excel Connector