docs(api): add OpenAPI spec and interactive API explorer - #389
Merged
Conversation
- Add swaggo/swag as a Go tool dependency (go.mod) - Create internal/api/doc.go with global swag annotation block (12 tags, Bearer + ApiKey auth schemes) - Annotate all ~95 handler functions across 17 handler files with swag comments (@summary, @tags, @PARAM, @success, @failure, @Security, @router) - Generate docs/static/swagger.yaml and docs/static/swagger.json via swag init - Add docs/src/pages/api-explorer.tsx: interactive Swagger UI page using BrowserOnly + swagger-ui-react - Add API Explorer link to the Docusaurus navbar - Add gen-swagger script to docs/package.json - Replace verbose endpoints.md stub with concise overview + link to /api-explorer - Add webpack stream polyfill plugin to docusaurus.config.ts for swagger-ui-react compatibility Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
yoshitaka420
pushed a commit
to yoshitaka420/altmount
that referenced
this pull request
Jun 1, 2026
- Add swaggo/swag as a Go tool dependency (go.mod) - Create internal/api/doc.go with global swag annotation block (12 tags, Bearer + ApiKey auth schemes) - Annotate all ~95 handler functions across 17 handler files with swag comments (@summary, @tags, @PARAM, @success, @failure, @Security, @router) - Generate docs/static/swagger.yaml and docs/static/swagger.json via swag init - Add docs/src/pages/api-explorer.tsx: interactive Swagger UI page using BrowserOnly + swagger-ui-react - Add API Explorer link to the Docusaurus navbar - Add gen-swagger script to docs/package.json - Replace verbose endpoints.md stub with concise overview + link to /api-explorer - Add webpack stream polyfill plugin to docusaurus.config.ts for swagger-ui-react compatibility Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
docs/static/swagger.yamlanddocs/static/swagger.jsonfrom Go source annotations/api-explorer(BrowserOnly, no SSG issues)API Explorerlink to the Docusaurus navbarendpoints.mdstub with a concise overview pointing to the explorergen-swaggerscript todocs/package.jsonto regenerate the spec after handler changesHow the spec is generated
Test plan
bun run buildindocs/passes without errors/api-explorer→ Swagger UI loads with all 12 tag groups🤖 Generated with Claude Code