swagger

package module

v0.1.0 Latest Latest Go to latest Published: Mar 2, 2023 License: MIT Imports: 5 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

This is for swaggo extension library to set extra variables.

go get github.com/worldline-go/utility/swagger

This section is empty.

This section is empty.

func SetInfo(opts ...Option) error

type Option func(*options)

func WithBasePath(basePath string) Option

WithBasePath sets the base path of the API.

func WithCustom(custom map[string]interface{}) Option

WithCustom sets the custom data to be used in the swagger template.

Access custom data in the template with {{.Custom.key}}.

func WithDelims(delims string) Option

WithDelims sets the delimiters to be used in the SetInfo function.

The default delimiters are "[[ ]]"

func WithDescription(description string) Option

WithDescription sets the description of the API.

func WithHost(host string) Option

WithHost sets the host of the API.

func WithInfoInstanceName(infoInstanceName string) Option

WithInfoInstanceName sets the name of the swagger instance to be used.

The default name is "swagger".

func WithSchemes(schemes ...string) Option

WithSchemes sets the schemes of the API.

func WithTitle(title string) Option

WithTitle sets the title of the API.

func WithVersion(version string) Option

WithVersion sets the version of the API.