Gin Explorer

Go Gin Routes on Sidebar

A VS Code extension that automatically discovers and displays all Gin routes in your Go workspace, making it easy to navigate and explore your API endpoints.

Features

• Automatic Route Discovery: Scans your Go workspace and detects all Gin route definitions
• Organized View: Displays routes in a dedicated sidebar with HTTP method and path
• Quick Navigation: Click any route to jump directly to its definition in the source code
• Real-time Refresh: Manually refresh the route list to pick up changes
• Supports All HTTP Methods: GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, and Any

Usage

1. Open a Go workspace that uses the Gin framework
2. Click the Gin Explorer icon in the Activity Bar (left sidebar)
3. View all discovered routes in the Routes panel
4. Click any route to navigate to its definition
5. Use the refresh button to update the route list

Requirements

• VS Code 1.109.0 or higher
• A Go workspace with Gin framework routes

Supported Route Patterns

The extension detects Gin routes using the following patterns:

r.GET("/users", handler)
r.POST("/users", handler)
router.PUT("/users/:id", handler)
engine.DELETE("/users/:id", handler)

Commands

• Refresh Routes: Manually refresh the route list to detect new or modified routes

Known Issues

• Currently uses regex-based parsing, which may miss complex route definitions
• Nested route groups may not be fully detected
• Dynamic route registration may not be captured

Contributing

Found a bug or have a feature request? Please open an issue on GitHub.

License

MIT