Swag v2.0.0-rc6とは？Go API Documentation Generator

ページ内ナビ

概要

SwagはGo source codeのdeclarative commentを解析し、API documentを生成するCLI/toolです。Swagger 2.0を中心に、v2系ではOpenAPI v3機能も拡張され、Gin等のGo Web Framework用pluginとSwagger UI integrationを利用できます。

特徴と向いている用途

公式資料に基づく紹介・実機未検証 · 内容確認日：2026-10-06

主な特徴

handler周辺のannotationからAPI operationとschemaを生成する

general API info、route、parameter、response、security等をcomment annotationで記述し、swag initからdocs.go、JSON、YAML等のdocumentを生成できます。

出典：[2]

Swagger 2.0に加えてv2系でOpenAPI v3表現を拡張する

v2.0.0-rc6ではOpenAPI v3のenum重複修正、discriminator、oneOf周辺の修正等が含まれます。既存Swagger 2.0用途に加えv3系spec生成も進んでいます。

出典：[2][4]

向いている用途

Go Web APIのsource commentとAPI documentを近い場所で管理したい場合に向く

Gin等のhandler codeにannotationを置き、Swagger UIやclient向けspecをbuild時に生成したいbackend projectに適します。

出典：[2]

導入前の確認

v2.0.0-rc6はrelease candidate。go.modはGo 1.18、READMEのbuild案内はGo 1.19+

v2.0.0-rc6のgo.modはGo 1.18を指定し、READMEはsource buildにGo 1.19+を案内しています。v2はRC段階でOpenAPI v3周辺の変更が続いているため、generator versionをpinし、annotation parserとgenerated specのbreaking差分をCIで検証してください。

出典：[3][2][4]

参考にした公式資料

[1]swaggo/swag — GitHub repository(2026-10-06)
[2]Swag v2.0.0-rc6 — README(2026-10-06)
[3]Swag v2.0.0-rc6 — go.mod(2026-10-06)
[4]Swag v2.0.0-rc6 release(2026-10-06)
[5]Swag MIT license(2026-10-06)

編集部からの補足

handler付近のcommentからAPI documentを生成でき、Ginなど既存Go Web Frameworkへ組み込みやすいtoolです。v2系は現在RCなので、OpenAPI v3機能を使う場合はgenerator versionを固定し、生成specのdiffをCIで確認してください。

3ステップで試す

1
ソースを取得
git clone --depth 1 https://github.com/swaggo/swag.git
2
リポジトリへ移動
cd swag
3
公式手順を確認
READMEのInstallation / Quick Start / Getting Startedにある公式コマンドを続けて実行してください。
find . -maxdepth 1 -iname 'README*' -exec sed -n '1,220p' {} \; -quit

公式READMEで確認

成長

成長の推移 · 直近30日

13,040 Stars

推移データを蓄積中です。

開発アクティビティ

直近90日・週次

Commit（直近30日）: 5
Open PR: 63

開発アクティビティを蓄積中です。

Built with

カテゴリとタグ

GitHubデータ

GitHubのデータGitHubの詳細データを見る

GitHubで見る

GitHub Topics

golang
swagger
swagger2
annotations
openapi

Stars: 13,040
Forks: 1,545
Watchers: 113
Open Issues: 409
Contributors: 251
所有者種別: Organization
主要言語: Go
ライセンス: MIT
リポジトリ最終更新: 2026/09/30