Skip to main content
Feedback

Using Interactive Documentation

You can test an API from the Interactive Documentation page on your Developer Portal. To access the Interactive Documentation page, add /interactive-documentation to the client domain URL.

The Interactive Documentation URL is in the following format:

https://developer.<clientname>.com/interactive-documentation

For example, http://acme.com/interactive-documentation

Enabling the Endpoint for OpenAPI v3.0 (Swagger)

Procedure

  1. Ensure the following are on HTTPS:

    • Developer Portal

    • URLs in the Swagger

    • Token

    • Resource Endpoints

  2. Go to the Boomi Cloud API Management URL: https://evalXXXX.admin.mashery.com.

    1. Click API Definitions on the Get Started page or navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

    2. In the Name column, select the specific API name link next to the row for which you want to open endpoints.

    3. On the Endpoints: <your api name> page, in the Name column, select the specific endpoint link next to the row you want to open methods page.

    4. On the Methods: <your endpoint name> page, navigate to Cross-Origin Resource Sharing, and select Enable CORS toggle switch to enable CORS for both token and resource endpoints.

  3. Enable the HTTP OPTIONS method for the resource endpoint.

Performing these steps ensures that you avoid browser-mixed content and cross-origin restrictions.

Example of OAuth2 in OpenAPI v3.0 (Swagger)

The following is an example of the OpenAPI v3.0 specification that uses OAuth v2.0.

{
"openapi": "3.0.0",
"info": {
"title": "Acme OAuth API",
"description": "",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://server.api.acme.com/acmeoauth/v1",
"variables": {}
}
],
"paths": {
"/product": {
"get": {
"tags": [
"Default"
],
"summary": "v1 product",
"description": "",
"operationId": "V1Product",
"parameters": [
{
"name": "productId",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "object"
}
}
}
}
},
"deprecated": false,
"security": [
{
"oauthToken": []
}
]
}
},
"/order": {
"get": {
"tags": [
"Default"
],
"summary": "v1 order",
"description": "",
"operationId": "V1Order",
"parameters": [
{
"name": "orderId",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "object"
}
}
}
}
},
"deprecated": false,
"security": [
{
"oauthToken": []
}
]
}
}
},
"components": {
  "securitySchemes": {
"oauthToken": {
"type": "oauth2",
"description": "Mashery OAuth Idp",
"flows": {
"clientCredentials": {
"tokenUrl": "https://server.api.acme.com/oauth2/auth/c2p49gb3my95ym5hgsxf9wav",
"scopes": {}
}
}
}
}
},
"security": [
{
"oauthToken": []
}
],
"tags": [
{
"name": "Default",
"description": ""
}
]
}
On this Page