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.
Installer avec mon Agent
Copiez cette demande dans votre Agent. Elle contient la page Skill de référence et le manifeste.
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.Votre Agent doit toujours présenter son plan et demander toute confirmation exigée par la politique de sécurité.
Ressources lisibles par les agents
Utilisez ces liens lorsquâun Agent IA, un crawler ou un script a besoin dâun contexte propre au lieu de lire toute la page.
Tester
Utilisation de « golang-swagger ». A Gin service has generated docs, but Swagger UI displays an empty specification.
Résultat attendu:
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.
Utilisation de « golang-swagger ». An endpoint returns a response envelope whose data field contains a user object.
Résultat attendu:
The documentation should use nested response composition so the generated schema shows the concrete user model inside the envelope.
Utilisation de « golang-swagger ». A user model needs documented roles, score limits, examples, and a hidden secret field.
Résultat attendu:
Use struct tags for allowed values, numeric bounds, example values, and Swagger-only exclusion while preserving required JSON serialization.
Audit de sécurité
SûrAll 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.
Facteurs de risque
âïž Commandes externes (50)
đ AccĂšs rĂ©seau (4)
Partager et citer ce rapport
Partagez le rapport dâĂ©valuation versionnĂ©, le badge neutre, la carte intĂ©grable et les citations. Skillstore prĂ©sente les preuves sans dĂ©cider si ce Skill est sĂ»r.
Copier le lien du rapport
https://skillstore.io/skills/samber-golang-swagger/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportBadge Markdown
[](https://skillstore.io/skills/samber-golang-swagger?utm_source=security_passport_badge)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>Carte intégrable
<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>Citations académiques (APA · BibTeX · CFF)
Citation 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/1Citation BibTeX
@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"
Score Skillstore
Pourquoi ce score Niveau de confiance des preuves: MoyenCe que vous pouvez créer
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.
Essayez ces prompts
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.
Bonnes pratiques
- 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.
Ăviter
- 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.
Foire aux questions
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?
Détails du développeur
Auteur
samberLicence
MIT
Version de lâauteur
v1.1.2
Révision Skillstore
r1
Réf
2aa351cb09c29b7287d263bd8ea81e9bee3b2a61
Récence de maintenance
30/09/2026
Utilisation
0 téléchargements · 0 vues
Structure de fichiers