fix(cli): link dev banner to interactive API docs instead of root#1512
Merged
Conversation
The ready banner's `API:` line pointed at `/` — the server root, not the API. Replace it with an `API Docs:` link to `<apiBase>/docs`, the interactive Scalar/OpenAPI explorer, which is the actual human entry point into the running API. The bare `/api/v1` index is a machine-facing route list and isn't worth a banner line. Adds an optional `apiBasePath` (default `/api/v1`). ➜ API Docs: http://localhost:3999/api/v1/docs ➜ Console: http://localhost:3999/_console/ Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
size/s
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The dev startup banner's
API:line pointed at/— the server root, not the API. This replaces it with an API Docs link to the interactive Scalar/OpenAPI explorer:Why
Probing the running showcase:
/api/v1/docs/api/v1/api/v1//(oldAPI:target)The interactive docs is the useful human entry point; the bare
/api/v1index is machine-facing and not worth a banner line, and the old/target was misleading. Adds an optionalapiBasePath(default/api/v1).Verified: banner renders the two lines;
GET /api/v1/docs→ 200 HTML,GET /api/v1/openapi.json→ 200. cli tests 144 ✓.🤖 Generated with Claude Code