golang-swagger SKILL.md skillA

golang-swagger from yzfly/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add yzfly/skills/golang-swagger@v1.0.0

Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
yzfly/skills
Path
skills/cto/references/payload/backend/golang/golang-swagger/SKILL.md
Versions recorded
1
Latest version
v1.0.0, committed May 3, 2026
Size
8,840 bytes
Repository stars
12
License
a license file GitHub does not identify

Golang OpenAPI/Swagger documentation with swaggo/swag — annotation comments (@Summary, @Param, @Success, @Router, @Security), swag init code generation, framework integrations (gin, echo, fiber, chi, net/http), security definitions (Bearer/JWT, OAuth2, API key), and struct tags (swaggertype, enums, example, swaggerignore). Apply when adding or maintaining Swagger/OpenAPI docs in a Go project, or when the codebase imports github.com/swaggo/swag, github.com/swaggo/gin-swagger…

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

**Persona:** You are a Go API documentation engineer. You treat docs as a contract — accurate, complete annotations prevent integration bugs and make the Swagger UI the source of truth for API consumers.

**Modes:**

- **Build** — adding Swagger to a new or existing Go project: set up the toolchain, annotate handlers, generate docs, wire the UI endpoint.
- **Audit** — reviewing existing swagger annotations for completeness, correctness, and security coverage.

## Setup

Three steps to get Swagger UI running:

```bash
swag init                        # generates docs/ with docs.go, swagger.json, swagger.yaml
swag init -g cmd/api/main.go     # if general info is not in main.go
swag fmt                         # format annotation comments (like go fmt)
```

Import the `docs` package to register the spec. Use a blank import when only wiring the UI; use a named import when you also need to override `docs.SwaggerInfo` at runtime:

```go
import _ "yourmodule/docs"          // blank: registers spec, no identifier
import docs "yourmodule/docs"       // named: use when overriding SwaggerInfo
```

Wire the UI endpoint — pick your framework:

```go
// Gin
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add yzfly/skills/golang-swagger@sha256:5ac1592d96322860

The line at the top of this page pins the label v1.0.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_2eaddnefdkzytgzq.svg)](https://markdownregistry.com/a/art_2eaddnefdkzytgzq)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on May 3, 2026.

versioncommittedcommitsizeaudit
v1.0.0 latest2026-05-03 c091e90 8,840 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (8840 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

yzfly/skills · 12 stars · license a license file GitHub does not identify · pushed 2026-09-26 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_2eaddnefdkzytgzq
GET https://markdownregistry.com/api/v1/resolve?ref=yzfly/skills/golang-swagger
GET https://markdownregistry.com/api/v1/blob/5ac1592d96322860a5591f2efb4fe2178ee287c5b9d2d0afe458efd73f0b5919

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from yzfly/skills

anti-ai-copy SKILL.md skill
yzfly/skills · skills/anti-ai-copy/SKILL.md · 软件界面文案(UI copy / microcopy / UX writing)写作与去 AI 味。当用户要写、改、审界面文案时使用:按钮、页面标题、表单标签、占位符、空状态、Toast /…
v1.0.0 · audit A · 12 stars
brand-narrative SKILL.md skill
yzfly/skills · skills/brand-narrative/SKILL.md · 品牌叙事策略。当用户要做品牌叙事 / 品牌故事 / 品牌定位 / 品牌策略、问「我们的品牌到底围绕什么」「该讲产品还是讲文化」、想判断某个新品 / 联名 / 内容「符不符合品牌」、或为 0–1…
v1.0.0 · audit A · 12 stars
breathing-brand SKILL.md skill
yzfly/skills · skills/breathing-brand/SKILL.md · 出海 / 国际化品牌的极简呼吸感视觉全案。当用户说要做品牌 VI、品牌视觉、logo 与周边、独立站视觉、社区 / 组织 / 产品的品牌形象,或抱怨自己的品牌「看起来廉价」「太满太乱」「不够国际化 /…
v1.0.0 · audit A · 12 stars
cto SKILL.md skill
yzfly/skills · skills/cto/SKILL.md · Startup / AI-startup CTO who is also a top-tier individual contributor. Two modes: (1) greenfield — turn fuzzy business…
git:20260504.146b163 · audit A · 12 stars
golang-benchmark SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-benchmark/SKILL.md · Golang benchmarking, profiling, and performance measurement. Use when writing, running, or comparing Go benchmarks…
v1.1.3 · audit A · 12 stars
golang-cli SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-cli/SKILL.md · Golang CLI application development. Use when building, modifying, or reviewing a Go CLI tool — especially for command…
v1.1.3 · audit A · 12 stars
golang-code-style SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-code-style/SKILL.md · Golang code style, formatting and conventions. Use when writing Go code, reviewing style, configuring linters, writing…
v1.1.2 · audit A · 12 stars
golang-concurrency SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-concurrency/SKILL.md · Golang concurrency patterns. Use when writing or reviewing concurrent Go code involving goroutines, channels, select…
v1.1.3 · audit A · 12 stars
golang-context SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-context/SKILL.md · Idiomatic context.Context usage in Golang — creation, propagation, cancellation, timeouts, deadlines, context values…
v1.1.1 · audit A · 12 stars
golang-continuous-integration SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-continuous-integration/SKILL.md · Provides CI/CD pipeline configuration using GitHub Actions for Golang projects. Covers testing, linting, SAST, security…
v1.2.0 · audit A · 12 stars
golang-data-structures SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-data-structures/SKILL.md · Golang data structures — slices (internals, capacity growth, preallocation, slices package), maps (internals, hash…
v1.1.1 · audit A · 12 stars
golang-database SKILL.md skill
yzfly/skills · skills/cto/references/payload/backend/golang/golang-database/SKILL.md · Comprehensive guide for Go database access. Covers parameterized queries, struct scanning, NULLable column handling…
v1.1.2 · audit A · 12 stars

Every file in yzfly/skills

Other files named golang-swagger

golang-swagger SKILL.md skill
samber/cc-skills-golang · skills/golang-swagger/SKILL.md · Golang OpenAPI/Swagger documentation with swaggo/swag — annotation comments (@Summary, @Param, @Success, @Router…
v1.1.2 · audit A · 3,523 stars
golang-swagger SKILL.md skill
aiskillstore/marketplace · pending/samber/golang-swagger/SKILL.md · Golang OpenAPI/Swagger documentation with swaggo/swag — annotation comments (@Summary, @Param, @Success, @Router…
v1.1.2 · audit A · 439 stars

Browse by kind, by grade A, or by owner.