openapi

README

REF: github.com/getkin/go-openapi

DEPS

1. easyjson
2. go-openapi/swag

Documentation

Index

• Variables
• func Generate(doc string, opt ...Option) error
• func OpenAPIToHTTPFlow(t string)
• func OpenAPITypeToMockDataLiteral(t string, defaults ...any) any
• func ValueViaField(field string, t string, defaults ...any) any
• type OpenAPIConfig
  • func NewDefaultOpenAPIConfig() *OpenAPIConfig
• type Option
  • func WithDomain(domain string) Option
  • func WithFlowHandler(handler func(flow *yakit.HTTPFlow)) Option
  • func WithHttps(b bool) Option

Variables

var Exports = map[string]any{
	"Generate":    Generate,
	"https":       WithHttps,
	"flowHandler": WithFlowHandler,
	"domain":      WithDomain,
}

Functions

func Generate

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

func OpenAPIToHTTPFlow(t string)

func OpenAPITypeToMockDataLiteral

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

func ValueViaField

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

Types

type OpenAPIConfig

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

func NewDefaultOpenAPIConfig

func NewDefaultOpenAPIConfig() *OpenAPIConfig

type Option

type Option func(config *OpenAPIConfig)

func WithDomain

func WithDomain(domain string) Option

WithDomain means use this domain

func WithFlowHandler

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

WithFlowHandler means use this handler

func WithHttps

func WithHttps(b bool) Option

WithHttps means use https