Skip to content

Commit 946e3cd

Browse files
authored
Enhance README with Preview panel details (#21)
Updated the Preview panel section with renderer options and improved clarity on interaction features.
1 parent c823416 commit 946e3cd

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,16 +240,27 @@ are read directly from your VSCode settings.
240240

241241
### Preview
242242

243-
The Preview panel (powered by [SwaggerUI](https://github.com/swagger-api/swagger-ui)) renders the current OpenAPI document and lets you interact with it.
243+
The Preview panel renders the current OpenAPI document and lets you interact with it.
244244
Preview panel can be opened by opening the Command Palette (CTRL+Shift+P) and running the `OpenAPI Toolkit: Show API Document preview` command.
245245

246-
![SpecLynx OpenAPI Toolkit Preview](https://github.com/user-attachments/assets/67c4e9a9-9084-41ab-bbbe-a01bb50d3457)
246+
Supported renderers:
247+
248+
- [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference#readme) (default)
249+
- [SwaggerUI](https://github.com/swagger-api/swagger-ui)
250+
251+
To switch between renderers, change the `speclynx.openapi.preview.renderer` setting in your VSCode configuration.
252+
253+
###### Scalar API Reference
254+
![Scalar API Reference Preview](https://github.com/user-attachments/assets/176f07bf-b54a-42d7-91c3-d3d745017e5e)
255+
256+
###### SwaggerUI
257+
![SwaggerUI Preview](https://github.com/user-attachments/assets/67c4e9a9-9084-41ab-bbbe-a01bb50d3457)
247258

248259

249260
Preview interactions include:
250261

251262
* **Live rendering** — Quickly verify how changes look without leaving the editor
252263
* **Server selection & auth** — Choose servers and authorize requests where applicable
253-
* **Try it out** — Execute operations directly from the preview to validate requests/responses during development
264+
* **Try it out / Test request** — Execute operations directly from the preview to validate requests/responses during development
254265

255266
This helps you validate the specification from both a structural and a consumer point of view. 

0 commit comments

Comments
 (0)