RunLogosRunLogos
中文EN

OpenAPI Editor

The OpenAPI Editor is a visual interface for your openapi.yaml spec. It replaces raw YAML editing with a structured tree view and adds a live debug tab so you can test endpoints without leaving RunLogos.

Available in RunLogos Pro.

Opening the editor

  1. Click logos/resources/api/openapi.yaml in the file tree.
  2. The center panel loads the OpenAPI Editor automatically.
  3. Endpoints are grouped by tag in the left-side list.

Browsing endpoints

Select any endpoint from the list to see its full definition in the right pane:

  • Path and HTTP method
  • Path parameters and query parameters
  • Request body schema — expandable tree with field names, types, and required flags
  • Response schemas — one tab per status code (200, 400, 401, 404, …)
  • Authentication — which security scheme applies

All fields are editable inline. Changes write back to openapi.yaml on save.

Debug tab

Switch to the Debug tab on any endpoint to send a live request:

  1. Fill in the base URL (e.g. http://localhost:3000).
  2. Set path/query params and request body — the editor pre-fills from the schema.
  3. Add auth headers if needed.
  4. Click Send.

RunLogos shows the raw HTTP request and response side-by-side. Response body is pretty-printed JSON. Status code and latency are shown at the top.

Typical workflow during Phase 07 (Code Generation):

  1. AI generates the backend code.
  2. Start the dev server in the terminal panel.
  3. Open the OpenAPI Editor → Debug tab.
  4. Test each endpoint against the running server.
  5. If a response doesn't match the spec, highlight the discrepancy and use Comment-to-Prompt to generate a fix instruction for the agent.

Traceability

Each endpoint in the spec includes a scenario reference comment (added by the API Skill):

# Scenario: S01 step 2 — App → API

This lets you trace any endpoint back to the sequence diagram that defined it.

Next step

SQL Designer