fw_openapi

package module

v0.3.3 Latest Latest Go to latest Published: Jul 15, 2025 License: MIT Imports: 15 Imported by: 0

Details

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

Repository

github.com/linxlib/fw_openapi

Links

Open Source Insights

README ¶

fw_openapi

generate openapi documents from linxlib/astp

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type OpenAPI ¶

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

func NewOpenAPIPlugin ¶ added in v0.2.0

func NewOpenAPIPlugin() *OpenAPI

func (*OpenAPI) HandleServerInfo ¶

func (oa *OpenAPI) HandleServerInfo(si []*types.Comment)

func (*OpenAPI) HandleStructs ¶

func (oa *OpenAPI) HandleStructs(ctl *types.Struct)

func (*OpenAPI) InitPlugin ¶ added in v0.2.0

func (oa *OpenAPI) InitPlugin(s *fw.Server)

func (*OpenAPI) NewFieldProp ¶ added in v0.3.0

func (oa *OpenAPI) NewFieldProp(f *types.Field,
	tagName string, defaultValue string, comment string, exampleValue string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewObjectParameters ¶ added in v0.3.0

func (oa *OpenAPI) NewObjectParameters(f *types.Struct, tagName string) []*spec.RefOrSpec[spec.Extendable[spec.Parameter]]

func (*OpenAPI) NewObjectProp ¶ added in v0.3.0

func (oa *OpenAPI) NewObjectProp(f *types.Struct, tagName string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewParentFieldProp ¶ added in v0.3.0

func (oa *OpenAPI) NewParentFieldProp(f *types.Struct, tagName string) map[string]*spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewTag ¶ added in v0.3.0

func (oa *OpenAPI) NewTag(tagName string, desc string) *spec.Extendable[spec.Tag]

func (*OpenAPI) Print ¶

func (oa *OpenAPI) Print(slot string)

func (*OpenAPI) WriteOut ¶

func (oa *OpenAPI) WriteOut() error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
middleware

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