-
Notifications
You must be signed in to change notification settings - Fork 4
15.6 Playground improvements
ArtemNalesnikovskyi edited this page Oct 22, 2025
·
3 revisions
| Step | ER |
|---|---|
| 1. Log in to APIHUB as a user and navigate to a package version with an API operation. | The system displays the Playground sidebar for the selected operation. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens with "Add Custom Server URL" as the default flow. |
| 3. Enter a valid absolute URL (e.g., "https://example.com/api") and description (e.g., "Test Server"). | The fields accept the input; "Add" button is enabled. |
| 4. Click "Add". | The popup closes, a notification shows "Server has been added", the server appears at the end of the dropdown with caption "Test Server", and the server field shows the full URL with operation path (e.g., "https://example.com/api/v1/resource"). The server is saved in local storage. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with an API operation. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens with "Add Custom Server URL" selected. |
| 3. Enter a valid absolute URL (e.g., "https://example.com/api") and leave description empty. | The fields accept the input; "Add" button is enabled. |
| 4. Click "Add". | The popup closes, a notification shows "Server has been added", the server appears in the dropdown with caption "-", and the server field shows the full URL with operation path. The server is saved in local storage. |
[TC-P1-03] Add Custom Server via "Use Agent Proxy" Flow (Positive, with Additional Path and Description)
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with a service name (e.g., "my-service"). | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens with both flows available. |
| 3. Select "Use Agent Proxy", choose a Cloud agent, a valid namespace, enter additional path (e.g., "/extra"), and description (e.g., "Proxy Server"). | The service field is pre-filled with "my-service", fields accept input, and "Add" button is enabled. |
| 4. Click "Add". | The popup closes, a notification shows "Server has been added", the server appears in the dropdown with caption "Proxy Server", and the server field shows the generated URL (e.g., "https://apihub.example.com/apihub-nc/agents//namespaces//services/my-service/proxy/extra/v1/resource"). The server is saved in local storage. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with an API operation. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens. |
| 3. Leave Server URL empty and click "Add". | An error message appears: "The field must be filled." The popup remains open. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with an API operation. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens. |
| 3. Enter a relative URL (e.g., "/api") and click "Add". | An error message appears: "The value must be an absolute URL." The popup remains open. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with a service name. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The "Add Custom Server" popup opens. |
| 3. Select "Use Agent Proxy", choose a Cloud agent, select a namespace where the service does not exist, and click "Add". | An error message appears: "Service not found in selected namespace." The popup remains open. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version without a service name. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown and select "Add Custom Server". | The popup opens with only "Add Custom Server URL" available. An info icon tooltip shows: "Only adding a custom server is available. To use the Agent proxy, specify the service name for the current ." |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with a spec server including a description (e.g., "Prod Server"). | The system displays the Playground sidebar. |
| 2. Click the server field dropdown. | The server appears in the dropdown with caption "Prod Server". |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with a spec server lacking a description. | The system displays the Playground sidebar. |
| 2. Click the server field dropdown. | The server appears in the dropdown with caption "-". |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and add a custom server with a description (e.g., "Custom Test") via TC-P1-01. | The server is added successfully. |
| 2. Click the server field dropdown. | The custom server appears with caption "Custom Test". |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and add a custom server without a description via TC-P1-02. | The server is added successfully. |
| 2. Click the server field dropdown. | The custom server appears with caption "-". |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with an absolute spec server (e.g., "https://example.com/base"). | The system displays the Playground sidebar. |
| 2. Select the server from the dropdown. | The server field shows the full URL with operation path (e.g., "https://example.com/base/v1/resource"). |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and add a custom server (e.g., "https://test.com") via TC-P1-01. | The server is added successfully. |
| 2. Select the custom server from the dropdown. | The server field shows the full URL with operation path (e.g., "https://test.com/v1/resource"). |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with a relative spec server (e.g., "/relative"). | The system displays the Playground sidebar. |
| 2. Click the server field dropdown. | The relative server is not listed in the dropdown. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with no servers (spec or custom). | The system displays the Playground sidebar with an empty server field. |
| 2. Hover over the Send button. | The Send button is disabled; a tooltip shows: "Please add a server". |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and navigate to a package version with an API operation. | The system displays the Playground sidebar. |
| 2. Select a non-agent server (spec or custom direct URL) and fill required parameters/body. | The server is selected, and parameters/body are valid. |
| 3. Click "Send". | The request is routed via GET /playground/proxy, and the response is displayed in the Playground Response section. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and add an agent proxy server via TC-P1-03. | The server is added successfully. |
| 2. Select the agent proxy server and fill required parameters/body. | The server is selected, and parameters/body are valid. |
| 3. Click "Send". | The request is routed via GET /agents/{agentId}/namespaces/{name}/services/{serviceId}/proxy/{path}, and the response is displayed in the Playground Response section. |
| Step | ER |
|---|---|
| 1. Log in to APIHUB and select a server matching the current APIHUB domain. | The system displays the Playground sidebar. |
| 2. Fill required parameters/body and click "Send". | The request is routed via the proxy endpoint (not direct), and the response is displayed in the Playground Response section. |
Processes description
Technical articles
Design Items
- Navigation to APIHUB (log in / log out)
- Create Workspace
- Create Group
- Create Package
- Favorite packages, dashboards, groups, workspaces
- Shared Packages
- Activity History in Main Page
- Personal private workspace
- Version summary
- Revision History
- Package Activity History
- Manage Manual Operations Group
- Export Operations Group (reduced source specifications)
- Export Operations Group (combined specification)
- Export List of Operations in Excel
- Search and Filter Operations
- List of Operations
- List of Operations Groups
- Manage REST Path Prefix Group
- Activity History
- List of Deprecated Operations
- Export List of Changes in Excel
- Human‐readable description for deprecated items for OpenAPI 3.0
- List of Documents
- OpenAPI Document Overview
- Copy Package Version
- Export Package Version
- Export Document from Package Version
- Export List of Deprecated Operations in Excel
- API Quality Validation Result
- Export of discrepancy analysis results for arbitrary package versions in Excel
- AI Recommendations Tab
- General Settings
- Package versions list
- Access Tokens Management
- Delete Package
- Default Release Version
- Define Release Version Pattern