Using the Swagger UI with the Web API
The Web API hosts an instance of the Swagger UI application for generating a visual representation of the OpenApi specification of the Web API. To access it, go to the /SwaggerUI endpoint, for example: https://<hostname>/SPSSMR/WebApi/SwaggerUI.
To make a request to an endpoint
1 On the Swagger UI page, select the version of the Web API that you want to use from the “Select a definition” list.
2 Click Try it out.
The endpoints initially show an open padlock icon; this indicates that the user requires authentication.
3 To authenticate the user, click Authorize at the top, and then click Authorize on the dialog.
4 On the Interview Server Administration (ISA) page, login.
The padlock icon change to a closed padlock.
5 Click Try it out to enable the request parameters, and then click Execute to make the request.
Swagger UI shows example values for most parameters which assume the “MM1WithQuota” example project has been activated on the server. If this project has been activated, you can click Try it out and then Execute without changing any of the parameter values.
Browser support
Swagger UI does not support Microsoft Internet Explorer.
See