Installation

Requirements

• Go 1.24 or later
• Ginkgo v2 and Gomega in your test module

Install

go get github.com/oaswrap/gswag

Install Ginkgo (if needed)

go get github.com/onsi/ginkgo/v2
go get github.com/onsi/gomega

To also install the ginkgo CLI for running suites and parallel execution:

go install github.com/onsi/ginkgo/v2/ginkgo@latest

Bootstrap a Ginkgo suite

If your package does not yet have a Ginkgo suite file, generate one:

cd your/package
ginkgo bootstrap

This creates a suite_test.go that you then customise with gswag.Init and gswag.WriteSpec (see Quick Start).