Skip to main content

Test a REST Service

Prerequisites​

  • An imported OpenAPI or OData API specification, or a known base URL and endpoint path.

Steps​

  1. In API Playground, expand the service tree and select a REST operation, or click New Request.
  2. In the Request tab:
    • URL – the service's base address (e.g., https://api.example.com). For a request bound to an imported operation the engine appends that operation's path at send time, so do not type the path here. Variables like ${BaseUrl} are supported; under a non-Default environment this field shows the environment's endpoint instead — see Which URL a Request Uses.
    • Method – select the HTTP method: GET, POST, PUT, DELETE, PATCH.
    • Headers – add key/value headers (e.g., Content-Type: application/json).
    • Body – enter or generate the request body for POST/PUT/PATCH.
  3. In the Authentication tab, choose an auth mode if required (Basic, Bearer token, OAuth 2.0, API Key, etc.).
  4. Click Send.
  5. Inspect the response in the Response panel: status code, headers, body.

:::info Screenshot needed — light/dark 📸 rest-request-editor-light.png and rest-request-editor-dark.png — Request tab with URL, method, headers, body filled in :::

Using Imported Operations​

When an OpenAPI spec is imported, each operation appears in the service tree. Selecting an operation pre-fills the URL, method, and a typed body editor based on the spec's schema.

:::info Screenshot needed — light/dark 📸 openapi-operation-selected-light.png and openapi-operation-selected-dark.png :::

Limitations​

For every OpenAPI / OData construct that Aethrix degrades or rejects — with an example, what you see in Studio, and how severe it is — see Import Diagnostics — Unsupported structures & fallbacks (OpenAPI / OData tabs). This is the single, exclusive reference.

Tips​

  • Use the Object Editor for complex nested bodies.
  • Use Mapping to extract tokens or IDs from the response for subsequent requests.
  • Save frequently-used requests to the service tree via the Save button.

Next Steps​

Last updated on