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.
Mit meinem Agent installieren
Kopieren Sie diese Anfrage in Ihren Agent. Sie enthält die maßgebliche Skill-Seite und das Manifest.
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.Ihr Agent sollte weiterhin seinen Plan anzeigen und alle von der Sicherheitsrichtlinie verlangten Bestätigungen anfordern.
Agent-lesbare Ressourcen
Verwenden Sie diese Links, wenn ein KI-Agent, Crawler oder Skript sauberen Kontext benötigt, statt die vollständige Seite zu lesen.
Testen
„golang-swagger“ wird verwendet. A Gin service has generated docs, but Swagger UI displays an empty specification.
Erwartetes Ergebnis:
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“ wird verwendet. An endpoint returns a response envelope whose data field contains a user object.
Erwartetes Ergebnis:
The documentation should use nested response composition so the generated schema shows the concrete user model inside the envelope.
„golang-swagger“ wird verwendet. A user model needs documented roles, score limits, examples, and a hidden secret field.
Erwartetes Ergebnis:
Use struct tags for allowed values, numeric bounds, example values, and Swagger-only exclusion while preserving required JSON serialization.
Sicherheitsaudit
SicherAll 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.
Risikofaktoren
⚙️ Externe Befehle (50)
🌐 Netzwerkzugriff (4)
Diesen Bericht teilen & zitieren
Teile den versionierten Bewertungsbericht, das neutrale Badge, die Einbettungskarte und Zitate. Skillstore berichtet Nachweise, ohne zu entscheiden, ob dieser Skill sicher ist.
Berichtslink kopieren
https://skillstore.io/skills/samber-golang-swagger/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown-Badge
[](https://skillstore.io/skills/samber-golang-swagger?utm_source=security_passport_badge)HTML-Badge
<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>Einbettungskarte
<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>Wissenschaftliche Zitate (APA · BibTeX · CFF)
APA-Zitat
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-Zitat
@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-Score
Warum dieser Score Evidenzvertrauen: MittelWas Sie erstellen können
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.
Diese Prompts ausprobieren
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.
Bewährte Praktiken
- 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.
Vermeiden
- 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.
Häufig gestellte Fragen
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?
Entwicklerdetails
Autor
samberLizenz
MIT
Autorenversion
v1.1.2
Skillstore-Revision
r1
Ref.
2aa351cb09c29b7287d263bd8ea81e9bee3b2a61
Aktualität der Wartung
30.9.2026
Nutzung
0 Downloads · 0 Aufrufe
Dateistruktur