go-swagger-helper

Community

Keep Go Swagger docs accurate and up to date

AuthorLeiZhang-Hunter
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It prevents Swagger documentation from drifting out of sync with your Go gin controllers by ensuring annotations and generated docs are updated whenever routes, handlers, or request/response models change.

Core Features & Use Cases

  • Auto-maintenance of Swagger annotations: Helps you add or update @Summary, @Description, @Tags, @Param, @Success, and @Router in existing or new controller handlers.
  • Consistent project conventions: Aligns Swagger entrypoint routing, docs package usage, and generation tooling with repository conventions like app/routes/routes.go and app/docs.
  • Generation and troubleshooting guidance: Provides a clear workflow for running make swag (or cd app/ && swag init) and diagnosing common swag init failures such as model parsing issues or missing endpoints.

Quick Start

Ask the Skill: "Update the Swagger annotations for this gin controller handler and regenerate the Swagger docs so the endpoint appears in the Swagger UI."

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: go-swagger-helper
Download link: https://github.com/LeiZhang-Hunter/nova-factory-server/archive/main.zip#go-swagger-helper

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.