swagger

package

v0.0.0-...-4f44c80 Latest Latest Go to latest Published: May 17, 2023 License: Apache-2.0 Imports: 11 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 section is empty.

View Source

var ErrNoServiceDefinition = errors.New("no service definition found")

func WithBearerAuthentication() func(target *spec.Swagger)

type SwaggerOpt func(*spec.Swagger)

type Writer struct {
	*spec.Swagger
	// contains filtered or unexported fields
}

func NewWriter(filename, hostname, pathPrefix string, swaggerOpt ...SwaggerOpt) *Writer

func (sw *Writer) Enum(enum *proto.Enum)

func (sw *Writer) Get() []byte

func (sw *Writer) Handlers() []proto.Handler

func (sw *Writer) Import(i *proto.Import)

func (sw *Writer) Message(msg *proto.Message)

func (sw *Writer) Package(pkg *proto.Package)

func (sw *Writer) RPC(rpc *proto.RPC)

func (sw *Writer) Save(filename string) error

func (sw *Writer) WalkFile() error