openapi

package

v1.3.2 Latest Latest Go to latest Published: Apr 12, 2024 License: AGPL-3.0 Imports: 17 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 Exports = map[string]any{
	"Generate":    Generate,
	"https":       WithHttps,
	"flowHandler": WithFlowHandler,
	"domain":      WithDomain,
}

func Generate(doc string, opt ...Option) error

Generate means generate yakit.HTTPFlow via openapi2/3 scheme use WithFlowHandler to recv and handle it Example:

openapi.Generate(fileName, openapi.flowHandler(flow => {
	dump(flow.Url)
}))

func OpenAPIToHTTPFlow(t string)

func OpenAPITypeToMockDataLiteral(t string, defaults ...any) any

func ValueViaField(field string, t string, defaults ...any) any

type OpenAPIConfig struct {
	Domain      string
	FlowHandler func(flow *yakit.HTTPFlow)
	IsHttps     bool
}

func NewDefaultOpenAPIConfig() *OpenAPIConfig

type Option func(config *OpenAPIConfig)

func WithDomain(domain string) Option

WithDomain means use this domain

func WithFlowHandler(handler func(flow *yakit.HTTPFlow)) Option

WithFlowHandler means use this handler

func WithHttps(b bool) Option

WithHttps means use https

Path	Synopsis
jsonpointer
marshmallow
openapi2 Package openapi2 parses and writes OpenAPIv2 specification documents.	Package openapi2 parses and writes OpenAPIv2 specification documents.
openapi3 Package openapi3 parses and writes OpenAPI 3 specification documents.	Package openapi3 parses and writes OpenAPI 3 specification documents.
openapigen
openapiyaml
swag