golang-swagger
Document Go APIs with Swagger
Go API annotations often become incomplete, inconsistent, or difficult to generate. This skill guides accurate OpenAPI documentation, Swagger UI wiring, and schema generation with swaggo.
๋ด ์์ด์ ํธ๋ก ์ค์น
์ด ์์ฒญ์ ์์ด์ ํธ์ ๋ณต์ฌํ์ธ์. ๊ณต์ Skill ํ์ด์ง์ ๋งค๋ํ์คํธ๊ฐ ํฌํจ๋์ด ์์ต๋๋ค.
Review the Skillstore skill "golang-swagger" from https://skillstore.io/skills/samber-golang-swagger.md and its manifest at https://skillstore.io/api/skills/samber-golang-swagger/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.์์ด์ ํธ๋ ๊ณ์ํด์ ๊ณํ์ ํ์ํ๊ณ ๋ณด์ ์ ์ฑ ์์ ์๊ตฌํ๋ ํ์ธ์ ์์ฒญํด์ผ ํฉ๋๋ค.
์์ด์ ํธ๊ฐ ์ฝ๊ธฐ ์ฌ์ด ๋ฆฌ์์ค
AI ์์ด์ ํธ, ํฌ๋กค๋ฌ, ์คํฌ๋ฆฝํธ๊ฐ ์ ์ฒด ํ์ด์ง ๋์ ์ ๋ฆฌ๋ ์ปจํ ์คํธ๋ง ํ์ํ ๋ ์ด ๋งํฌ๋ฅผ ์ฌ์ฉํ์ธ์.
ํ ์คํธํด ๋ณด๊ธฐ
"golang-swagger" ์ฌ์ฉ ์ค์ ๋๋ค. A Gin service has generated docs, but Swagger UI displays an empty specification.
์์ ๊ฒฐ๊ณผ:
The fix is to register the generated docs package with a blank import, mount the Gin Swagger handler, regenerate the specification, and verify the route.
"golang-swagger" ์ฌ์ฉ ์ค์ ๋๋ค. An endpoint returns a response envelope whose data field contains a user object.
์์ ๊ฒฐ๊ณผ:
The documentation should use nested response composition so the generated schema shows the concrete user model inside the envelope.
"golang-swagger" ์ฌ์ฉ ์ค์ ๋๋ค. A user model needs documented roles, score limits, examples, and a hidden secret field.
์์ ๊ฒฐ๊ณผ:
Use struct tags for allowed values, numeric bounds, example values, and Swagger-only exclusion while preserving required JSON serialization.
๋ณด์ ๊ฐ์ฌ
์์ All 89 static findings are false positives caused by Markdown backticks, documentation URLs, Go annotations, evaluation text, or tool metadata rather than executable threats. Review of the three scanned files found no prompt-injection text, unauthorized network behavior, or data-exfiltration intent.
์ํ ์์ธ
โ๏ธ ์ธ๋ถ ๋ช ๋ น์ด (50)
๐ ๋คํธ์ํฌ ์ ๊ทผ (4)
์ด ๋ณด๊ณ ์ ๊ณต์ ๋ฐ ์ธ์ฉ
๋ฒ์ ์ด ์ง์ ๋ ํ๊ฐ ๋ณด๊ณ ์, ์ค๋ฆฝ ๋ฐฐ์ง, ์๋ฒ ๋ ์นด๋ ๋ฐ ์ธ์ฉ์ ๊ณต์ ํ์ธ์. Skillstore๋ ๊ทผ๊ฑฐ๋ฅผ ๋ณด๊ณ ํ์ง๋ง ์ด Skill์ ์์ ์ฌ๋ถ๋ฅผ ํ๋จํ์ง ์์ต๋๋ค.
๋ณด๊ณ ์ ๋งํฌ ๋ณต์ฌ
https://skillstore.io/skills/samber-golang-swagger/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown ๋ฐฐ์ง
[](https://skillstore.io/skills/samber-golang-swagger?utm_source=security_passport_badge)HTML ๋ฐฐ์ง
<a href="https://skillstore.io/skills/samber-golang-swagger?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/samber-golang-swagger/security.svg" alt="Skillstore security assessment" loading="lazy"></a>์๋ฒ ๋ ์นด๋
<iframe src="https://skillstore.io/embed/skills/samber-golang-swagger.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>ํ์ ์ธ์ฉ (APA ยท BibTeX ยท CFF)
APA ์ธ์ฉ
samber. (2026). golang-swagger security audit report (audit version 1) [Author version 1.1.2]. Skillstore. https://skillstore.io/skills/samber-golang-swagger/audits/1BibTeX ์ธ์ฉ
@techreport{samber-samber-golang-swagger-2026,
author = {samber},
title = {golang-swagger security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/samber-golang-swagger/audits/1},
note = {Author version 1.1.2}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "golang-swagger security audit report (audit version 1)"
version: "1.1.2"
type: report
authors:
- name: "samber"
date-released: "2026-09-23"
url: "https://skillstore.io/skills/samber-golang-swagger/audits/1"
identifiers:
- type: other
value: "skillstore:samber-golang-swagger:audit:1"
description: "Skillstore immutable audit report identifier"
Skillstore ์ ์
์ด ์ ์์ ์ด์ ์ฆ๊ฑฐ ์ ๋ขฐ๋: ์ค๊ฐ๋ง๋ค ์ ์๋ ๊ฒ
Document a New Go API
Create endpoint annotations, response schemas, and a generated Swagger UI for a new Go service.
Repair an Existing Specification
Find annotation gaps, stale generated files, invalid response types, and missing security requirements.
Standardize Team Documentation
Apply consistent schemas, naming, constraints, examples, and framework wiring across multiple Go services.
์ด ํ๋กฌํํธ๋ฅผ ์ฌ์ฉํด ๋ณด์ธ์
Document this Go endpoint with a summary, parameters, success response, failure response, and route annotation. Explain where each comment belongs.
Connect generated swag documentation to my Go framework and explain the required imports, route registration, generation command, and verification steps.
Improve this API schema for nested response data, map values, timestamps, byte fields, enums, examples, and validation constraints. Identify unsupported patterns.
Review this Go service documentation for missing routes, inaccurate schemas, inconsistent annotations, stale generated files, and missing security requirements. Return prioritized fixes.
๋ชจ๋ฒ ์ฌ๋ก
- Regenerate documentation after annotation or model changes, then review the generated schema for accuracy.
- Keep security definitions and endpoint requirements explicit, consistent, and aligned with deployed authentication.
- Use named response types and focused annotations when generic maps or envelopes would produce ambiguous schemas.
ํผํ๊ธฐ
- Do not publish stale generated documentation that differs from current handlers or models.
- Do not hide fields with JSON exclusion when the application still needs to serialize them.
- Do not expose production Swagger UI without authentication, authorization, or an intentional deployment policy.
์์ฃผ ๋ฌป๋ ์ง๋ฌธ
Which Go frameworks does this skill cover?
Does this skill generate the OpenAPI files?
Can it document authentication?
How does it handle fields that Swagger should hide?
Can it document generic or nested responses?
Does it test the API implementation?
๊ฐ๋ฐ์ ์ธ๋ถ ์ ๋ณด
์์ฑ์
samber๋ผ์ด์ ์ค
MIT
์์ฑ์ ๋ฒ์
v1.1.2
Skillstore ๋ฆฌ๋น์
r1
๋ฆฌํฌ์งํ ๋ฆฌ
https://github.com/samber/cc-skills-golang/tree/19a0626ae8565d27a7b7bdf59d8d99d94d7e284c/skills/golang-swagger์ฐธ์กฐ
2aa351cb09c29b7287d263bd8ea81e9bee3b2a61
์ ์ง๋ณด์ ์ต์ ์ฑ
2026. 9. 30.
์ฌ์ฉ๋
0 ๋ค์ด๋ก๋ ยท 0 ์กฐํ
ํ์ผ ๊ตฌ์กฐ