go-api-docs
Installation
SKILL.md
When to Use
- Documenting HTTP API endpoints
- Generating OpenAPI/Swagger specs
- Writing service README files
- Documenting gRPC services (protobuf is self-documenting)
Critical Patterns
| Pattern | Rule |
|---|---|
| Swagger from annotations | Use swaggo/swag to generate OpenAPI from Go comments |
| Spec lives with service | Each service generates its own docs/swagger.json |
| Proto is self-documenting | gRPC services use protobuf comments as docs |
| README per service | Each service has a README with setup, architecture, API summary |
| Keep specs in sync | Regenerate on every API change — add to CI |
Swagger Annotations (swaggo/swag)
Related skills