openapi31

package

v0.5.7 Latest Latest Go to latest Published: Dec 25, 2023 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func AddRouter(path string, method string, input interface{})

AddRouter 添加一个路由

func Init() *reflector

func IsValid() bool

IsValid 判断 reflector 是否有效当前只前端是否为 nil

func Output()

func WithOptions(opts ...Option)

WithOptions 添加 options

type Option = func(r *reflector)

func WithDescription(dest string) Option

WithDescription 设置 openapi info: app description

func WithFile(output string) Option

WithFile 设置保存 openapi 数据的文件。如果不设置，将输出到 os.Stdout

func WithTitle(title string) Option

WithTitle 设置 openapi info: app title

func WithVersion(version string) Option

WithVersion 设置 openapi info: app version

type RespStructure struct {
	Output any
	Status int
}

type RespStructurer interface {
	RespStructure() []RespStructure
}

type SecurityStructure struct {
	Name  string
	Rules []string
}

type SecurityStructurer interface {
	SecurityStructure() []SecurityStructure
}