header

package

v1.0.0-beta Latest Latest Go to latest Published: Sep 14, 2022 License: MIT 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

Repository

github.com/yusufsyaifudin/openapidoc

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Header ¶

type Header struct {
	// contains filtered or unexported fields
}

func NewHeader ¶

func NewHeader() *Header

func (h *Header) Add(k string, v Map) *Header

func (h *Header) Components(gen *openapi3gen.Generator) (components openapi3.Components, err error)

Components returns openapi3.Components with the value of following fields: * openapi3.Schemas * openapi3.Headers * openapi3.Parameters

func (h *Header) RespHeaderRef() (refHeader map[string]string)

RespHeaderRef returns header actual key name as the map key, and string of referenced header as the value. Components must be called before call this function, otherwise this will return empty map.

type Map ¶

type Map struct {
	Value       string
	Description string
	Required    bool
}

Source Files ¶

View all Source files

header.go

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

header

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Header ¶

func NewHeader ¶

func (*Header) Add ¶

func (*Header) Components ¶

func (*Header) RespHeaderRef ¶

type Map ¶

Source Files ¶