swagger

package

v0.31.0 Latest Latest Go to latest Published: Oct 13, 2022 License: MIT Imports: 6 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

Repository

github.com/taxibeat/bake

Links

Open Source Insights

Documentation ¶

Overview ¶

Package swagger contains swagger/openapi related helpers to be used in mage targets.

Index ¶

Variables
type Swagger
- func (Swagger) Check() error
- func (Swagger) Create() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// OutputDir is the output directory for the generated files.
	OutputDir = "api"
	// MainGo is the path to the application entrypoint.
	MainGo = ""
	// ExtraArgs passed to the swag command.
	ExtraArgs = []string{"--parseVendor", "--outputTypes", "json,yaml"}
)

Functions ¶

This section is empty.

Types ¶

type Swagger ¶

type Swagger mg.Namespace

Swagger groups together Swagger related tasks.

func (Swagger) Check ¶

func (Swagger) Check() error

Check ensures that the generated files are up to date.

func (Swagger) Create ¶

func (Swagger) Create() error

Create creates a swagger files from source code annotations.

Source Files ¶

View all Source files

swagger.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL