README
¶
fw_openapi
generate openapi documents from linxlib/astp
Documentation
¶
Index ¶
- type OpenAPI
- func (oa *OpenAPI) HandleServerInfo(si []*types.Comment)
- func (oa *OpenAPI) HandleStructs(ctl *types.Struct)
- func (oa *OpenAPI) InitPlugin(s *fw.Server)
- func (oa *OpenAPI) NewFieldProp(f *types.Field, tagName string, defaultValue string, comment string, ...) *spec.RefOrSpec[spec.Schema]
- func (oa *OpenAPI) NewObjectParameters(f *types.Struct, tagName string) []*spec.RefOrSpec[spec.Extendable[spec.Parameter]]
- func (oa *OpenAPI) NewObjectProp(f *types.Struct, tagName string) *spec.RefOrSpec[spec.Schema]
- func (oa *OpenAPI) NewParentFieldProp(f *types.Struct, tagName string) map[string]*spec.RefOrSpec[spec.Schema]
- func (oa *OpenAPI) NewTag(tagName string, desc string) *spec.Extendable[spec.Tag]
- func (oa *OpenAPI) Print(slot string)
- func (oa *OpenAPI) WriteOut() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OpenAPI ¶
type OpenAPI struct {
*spec.OpenAPIBuilder
// contains filtered or unexported fields
}
func NewOpenAPIPlugin ¶ added in v0.2.0
func NewOpenAPIPlugin() *OpenAPI
func (*OpenAPI) HandleServerInfo ¶
func (*OpenAPI) HandleStructs ¶
func (*OpenAPI) InitPlugin ¶ added in v0.2.0
func (*OpenAPI) NewFieldProp ¶ added in v0.3.0
func (*OpenAPI) NewObjectParameters ¶ added in v0.3.0
func (*OpenAPI) NewObjectProp ¶ added in v0.3.0
func (*OpenAPI) NewParentFieldProp ¶ added in v0.3.0
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.