What problem does it solve?
This Skill helps Go developers keep OpenAPI and Swagger documentation accurate, consistent, and in sync with HTTP handlers so API clients and UI docs do not drift from the code.
Core Features & Use Cases
- Annotation-driven API docs: Write Swagger comments beside Go handlers using @Summary, @Param, @Success, @Router, and @Security.
- CLI and build workflow: Regenerate docs with swag init, format annotations with swag fmt, and wire checks into Makefile or CI to prevent stale specs.
- Framework integration: Add Swagger UI for Gin, Echo, Fiber, Chi, and net/http, and import the generated docs package correctly.
- Schema enrichment: Use struct tags like example, enums, swaggertype, and swaggerignore to model real request and response shapes.
- Use case: A team adding a protected order endpoint can document request validation, response schemas, bearer auth, and the /swagger UI without hand-editing generated files.
Quick Start
Use the go-swagger skill to document my Go API handler, generate Swagger output with swag, and tell me exactly which annotations, struct tags, and CI checks I need to keep the spec current.