openapi

package

v0.4.0 Latest Latest Go to latest Published: Sep 22, 2025 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dan-lugg/go-commands

Links

Open Source Insights

Documentation ¶

Index ¶

type SpecWriter
- func NewSpecWriter(mappingCatalog *commands.DefaultMappingCatalog, ...) (specWriter *SpecWriter)
type SpecWriterOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type SpecWriter ¶

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

func NewSpecWriter ¶

func NewSpecWriter(mappingCatalog *commands.DefaultMappingCatalog, handlerCatalog *commands.DefaultHandlerCatalog, options ...SpecWriterOption) (specWriter *SpecWriter)

func (*SpecWriter) CreatePathItem ¶

func (w *SpecWriter) CreatePathItem(reqName string, reqType reflect.Type, resType reflect.Type) (pathItem openapi3.PathItem, err error)

func (*SpecWriter) CreateSpec ¶

func (w *SpecWriter) CreateSpec() (spec openapi3.T, err error)

func (*SpecWriter) WriteSpec ¶

func (w *SpecWriter) WriteSpec(writer io.Writer) (err error)

type SpecWriterOption ¶

type SpecWriterOption = util.Option[*SpecWriter]

func WithDescription ¶

func WithDescription(description string) SpecWriterOption

func WithTitle ¶

func WithTitle(title string) SpecWriterOption

func WithVersion ¶

func WithVersion(version string) SpecWriterOption

Source Files ¶

View all Source files

openapi.go

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