Skip to content

feat(server): add scalar ui support for api documentation - #791

Closed
braden-w wants to merge 2 commits into
anomalyco:devfrom
EpicenterHQ:feat/scalar-ui-support
Closed

braden-w wants to merge 2 commits into
anomalyco:devfrom
EpicenterHQ:feat/scalar-ui-support

Conversation

@braden-w

@braden-w braden-w commented Jul 9, 2025 •

Copy link
Copy Markdown

This PR adds Scalar UI support to the opencode server as a modern alternative to traditional API documentation interfaces.

Changes

  • Added @scalar/hono-api-reference dependency
  • Integrated Scalar middleware at /ui endpoint (can be changed to /scalar)
  • UI automatically reads from existing OpenAPI spec at /doc

Implementation

Following the standard Hono integration approach from Scalar's official documentation, this provides a minimal one-line integration that leverages our existing OpenAPI specification.

Proposal: support both Swagger UI and Scalar UI

See also #790 which implements Swagger UI on /ui. I propose we support both interfaces simultaneously, but I'm open to changes:

  • Swagger UI at /ui - The familiar, industry-standard interface
  • Scalar UI at /scalar - Modern UI with dark mode, better search, and enhanced UX

I think supporting both could be really interesting for future documentation needs, but I'm also happy to go with whatever the team prefers. What do you guys think?

image

@github-actions
github-actions Bot force-pushed the dev branch 3 times, most recently from f1dc981 to 3e15a39 Compare November 22, 2025 18:07
@github-actions
github-actions Bot force-pushed the dev branch 3 times, most recently from f8ee907 to 6a9856d Compare November 27, 2025 01:29
@github-actions github-actions Bot closed this Nov 29, 2025
bussard76 pushed a commit to bussard76/openwork that referenced this pull request May 12, 2026
…#791)

Add a .d.ts file to resolve TS7016 error when importing a JavaScript
module without type declarations. This is a minimal fix that doesn't
require modifying tsconfig.json settings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant