The SRD API is enabled with an Open API (formerly know as swagger) specification document.
An Open API document describes about SRD API and enables other applications to read and visualize its resources. There are a variety of clients that can read an Open API document and generate API documentation.
The endpoint for SRD API's Open API document is: {serviceRoot}/doc
Open API Clients (SRD API Explorer)
An Open API document provides multiple possibilities for providing API documentation, one of which is using swagger-ui as a web client to explore SRD API. The SRD API exposes API Explorer at the following endpoint: {serviceRoot}/doc/explorer, allowing users to explore a SRD API directly from a browser.
To enable SRD API Explorer at {serviceRoot}/doc/explorer, you must:
-
Register a Smart Client (specifying the Implicit flow) with the same instance of Smart API Manager serving as SRD API's <security>/<oauth issuer>).
-
Add the following Post-Login Redirect URI for the Smart Client: <service root>/doc/explorer/oauth2-redirect.html
-
Replace <<ImplicitClientId>> with Client ID in the SRD API's Web.config file (as shown in below image).
The SRD API Explorer clients work only if SRD API follows the new scheme to specify
resource ID via scope. See the note entitled SAM changes related to access token request
in the Version 01.06.00.0420 release notes for details on the requirements.