-
Notifications
You must be signed in to change notification settings - Fork 35
Update Go backend API quickstart to new sample repository and v3.0.0 #490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request updates the Go backend API quickstart documentation to reference the new 01-Quickstart-Go-API sample repository and upgrades the go-jwt-middleware library from v2.3.0 to v3.0.0. The update includes comprehensive rewrites of the documentation to reflect v3's new features, including generics-based type-safe claims handling and a simplified options pattern API.
Changes:
- Updated sample repository links from
01-Authorization-RS256to01-Quickstart-Go-API - Upgraded go-jwt-middleware from v2.3.0 to v3.0.0 with breaking changes
- Rewrote quickstart documentation with expanded step-by-step guidance, troubleshooting tips, and best practices
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
main/docs/libraries.mdx |
Updated library version to v3.0.0, release date to Jan 20, 2026, and sample repository link |
main/snippets/sdks/SdkLibraries.mdx |
Updated sample repository link to new location |
main/snippets/quickstart/backend/golang/validator.go.mdx |
New snippet showing v3 validator setup with JWKS caching and options pattern |
main/snippets/quickstart/backend/golang/middleware.go.mdx |
New snippet for HTTP middleware configuration with error handling |
main/snippets/quickstart/backend/golang/main.go.mdx |
Completely rewritten main server with graceful shutdown and production timeouts |
main/snippets/quickstart/backend/golang/handlers.go.mdx |
New handlers demonstrating public, private, and scoped endpoint patterns |
main/snippets/quickstart/backend/golang/config.go.mdx |
New configuration loader for Auth0 environment variables |
main/snippets/quickstart/backend/golang/claims.go.mdx |
New custom claims implementation with scope validation |
main/docs/quickstart/backend/golang/interactive.mdx |
Major rewrite with expanded tutorial format, prerequisites, and troubleshooting |
main/docs/quickstart/backend/golang/index.mdx |
Major rewrite with comprehensive step-by-step guide and advanced topics |
main/docs/quickstart/backend/golang/_index.mdx |
Deleted file (content consolidated into other files) |
main/docs/quickstart/backend/golang/03-troubleshooting.mdx |
Enhanced with v3-specific troubleshooting scenarios and solutions |
main/docs/quickstart/backend/golang/02-using.mdx |
Updated port numbers (3010→8080), improved formatting, removed deprecated examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Modernize documentation with go-jwt-middleware latest version - Add comprehensive tutorial with 11 steps (index.mdx) and 10 steps (interactive.mdx) - Introduce modern UI components (Cards, Accordions, Steps, Tips, Warnings) - Add config package pattern for centralized environment variable management - Separate CustomClaims into dedicated claims.go file for better organization - Add useful Validate() method with optional scope validation - Update all endpoints to /api/private-scoped (was /api/scoped) - Add WithValidateOnOptions(false) for CORS preflight handling - Remove invalid issuer error from troubleshooting (code handles trailing slash automatically) - Update all code snippets to match auth0-golang-api-samples repository structure - Add new snippet files: claims.go.mdx, config.go.mdx, handlers.go.mdx, middleware.go.mdx, validator.go.mdx - Update 02-using.mdx with correct port (8080) and endpoint URLs - Fix troubleshooting guide numbering after removing invalid issuer section - Remove orphaned _index.mdx file - Remove write:messages permission (only read:messages is used)
c7a4c0a to
8120bf1
Compare
🔧 Changes
Updated the Go backend API quickstart documentation to reference the new
01-Quickstart-Go-APIsample repository and bumped the go-jwt-middleware library version to v3.0.0.What changed:
01-Authorization-RS256to01-Quickstart-Go-APIin English documentationWhy:
Files modified:
main/docs/quickstart/backend/golang/index.mdxmain/docs/quickstart/backend/golang/interactive.mdxmain/docs/libraries.mdxmain/snippets/sdks/SdkLibraries.mdx📚 References
🔬 Testing
Verified:
mint dev --port 3333�� Checklist