swaggo

package

v1.5.8 Latest Latest Go to latest Published: Apr 15, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package swaggo exposes openapi tools as library with sane defaults.

This section is empty.

This section is empty.

func GenerateDocs(ctx context.Context, searchDir, apiFile, outputDir string) error

GenerateDocs generates the OpenAPI docs with sane default config.

func GenerateDocsWithConf(ctx context.Context, conf gen.Config) error

GenerateDocsWithConf generates the OpenAPI docs with given config.

This section is empty.

Path	Synopsis
target Package target exposes swaggo targets that can be imported in magefile using [import syntax].	Package target exposes swaggo targets that can be imported in magefile using [import syntax].