openapi

package

v0.6.2 Latest Latest Go to latest Published: Mar 19, 2024 License: MIT Imports: 7 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/linxlib/kapi

Links

Open Source Insights

Documentation ¶

Index ¶

type BaseBuilder
- func (b *BaseBuilder) IsBuilt() bool
type Builder
- func NewBuilder() *Builder
type SchemaBuilder
- func NewSchemaBuilder() *SchemaBuilder
- func (s *SchemaBuilder) Build() spec.Schema
type Spec
- func NewSpec() *Spec

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BaseBuilder ¶

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

func (*BaseBuilder) IsBuilt ¶

func (b *BaseBuilder) IsBuilt() bool

type Builder ¶

type Builder struct {
	*BaseBuilder
	*spec.Swagger
}

func NewBuilder ¶

func NewBuilder() *Builder

func (*Builder) AddDefinitions ¶

func (b *Builder) AddDefinitions(name string, definitions spec.Schema)

func (*Builder) AddTag ¶

func (b *Builder) AddTag(tag spec.Tag)

func (*Builder) Build ¶

func (b *Builder) Build() *spec.Swagger

func (*Builder) SetHost ¶

func (b *Builder) SetHost(host string)

func (*Builder) String ¶

func (b *Builder) String() string

func (*Builder) WithInfo ¶

func (b *Builder) WithInfo(docName string, docVer string, docDesc string)

type SchemaBuilder ¶

type SchemaBuilder struct {
	*BaseBuilder
	spec.Schema
}

func NewSchemaBuilder ¶

func NewSchemaBuilder() *SchemaBuilder

func (*SchemaBuilder) Build ¶

func (s *SchemaBuilder) Build() spec.Schema

type Spec ¶

type Spec struct {
	*Builder
}

func NewSpec ¶

func NewSpec() *Spec

func (*Spec) AddRoute ¶

func (myspec *Spec) AddRoute(method string, path string, deprecated bool, summary string, tag string, requestParams []*spec.Parameter, responseParams []*spec.Response)

func (*Spec) Parameter ¶

func (myspec *Spec) Parameter(sReq *ast_parser.Struct, tag string) (params []*spec.Parameter)

func (*Spec) RequestParams ¶

func (myspec *Spec) RequestParams(sReq *ast_parser.Struct) (requestParams []*spec.Parameter)

func (*Spec) ResponseParams ¶

func (myspec *Spec) ResponseParams(sResp *ast_parser.Struct) (responseParams []*spec.Response)

Source Files ¶

View all Source files

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