fw_openapi

README

fw_openapi

generate openapi documents from linxlib/astp

Documentation

Index

• type OpenAPI
  • func NewOpenAPIPlugin() *OpenAPI
  • func (oa *OpenAPI) AddArraySchema(field *astp.Element, prop *spec.RefOrSpec[spec.Schema], tag string) *spec.RefOrSpec[spec.Schema]
  • func (oa *OpenAPI) AddObjectSchema(field *astp.Element, prop *spec.RefOrSpec[spec.Schema], tag string) *spec.RefOrSpec[spec.Schema]
  • func (oa *OpenAPI) AddResponse(op *spec.Extendable[spec.Operation], code string, ...)
  • func (oa *OpenAPI) HandleServerInfo(si []string)
  • func (oa *OpenAPI) HandleStructs(ctl *astp.Element)
  • func (oa *OpenAPI) InitPlugin(s *fw.Server)
  • func (oa *OpenAPI) Log(t string, msg string)
  • func (oa *OpenAPI) NewArrayObjectResponse(schemaName string, desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]
  • func (oa *OpenAPI) NewArraySchema(comment string) *spec.RefOrSpec[spec.Schema]
  • func (oa *OpenAPI) NewEnumSchema(v string) *spec.RefOrSpec[spec.Schema]
  • func (oa *OpenAPI) NewFloatProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])
  • func (oa *OpenAPI) NewIntProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])
  • func (oa *OpenAPI) NewObjectResponse(schemaName string, desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]
  • func (oa *OpenAPI) NewObjectSchema(comment string) *spec.RefOrSpec[spec.Schema]
  • func (oa *OpenAPI) NewProp(field *astp.Element, param ...*spec.RefOrSpec[spec.Extendable[spec.Parameter]]) (*spec.RefOrSpec[spec.Schema], bool, bool)
  • func (oa *OpenAPI) NewResponse(desc string, v string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]
  • func (oa *OpenAPI) NewSimpleParam(element *astp.Element, tag string) *spec.RefOrSpec[spec.Extendable[spec.Parameter]]
  • func (oa *OpenAPI) NewStringProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])
  • func (oa *OpenAPI) NewStringResponse(desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]
  • func (oa *OpenAPI) Print(slot string)
  • func (oa *OpenAPI) WriteOut() error

Types

type OpenAPI

type OpenAPI struct {
	*spec.Extendable[spec.OpenAPI]
	// contains filtered or unexported fields
}

func NewOpenAPIPlugin

func NewOpenAPIPlugin() *OpenAPI

func (*OpenAPI) AddArraySchema

func (oa *OpenAPI) AddArraySchema(field *astp.Element, prop *spec.RefOrSpec[spec.Schema], tag string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) AddObjectSchema

func (oa *OpenAPI) AddObjectSchema(field *astp.Element, prop *spec.RefOrSpec[spec.Schema], tag string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) AddResponse

func (oa *OpenAPI) AddResponse(op *spec.Extendable[spec.Operation], code string, resp *spec.RefOrSpec[spec.Extendable[spec.Response]])

func (*OpenAPI) HandleServerInfo

func (oa *OpenAPI) HandleServerInfo(si []string)

func (*OpenAPI) HandleStructs

func (oa *OpenAPI) HandleStructs(ctl *astp.Element)

func (*OpenAPI) InitPlugin

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

func (*OpenAPI) Log

func (oa *OpenAPI) Log(t string, msg string)

func (*OpenAPI) NewArrayObjectResponse

func (oa *OpenAPI) NewArrayObjectResponse(schemaName string, desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]

func (*OpenAPI) NewArraySchema

func (oa *OpenAPI) NewArraySchema(comment string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewEnumSchema

func (oa *OpenAPI) NewEnumSchema(v string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewFloatProp

func (oa *OpenAPI) NewFloatProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])

func (*OpenAPI) NewIntProp

func (oa *OpenAPI) NewIntProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])

func (*OpenAPI) NewObjectResponse

func (oa *OpenAPI) NewObjectResponse(schemaName string, desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]

func (*OpenAPI) NewObjectSchema

func (oa *OpenAPI) NewObjectSchema(comment string) *spec.RefOrSpec[spec.Schema]

func (*OpenAPI) NewProp

func (oa *OpenAPI) NewProp(field *astp.Element, param ...*spec.RefOrSpec[spec.Extendable[spec.Parameter]]) (*spec.RefOrSpec[spec.Schema], bool, bool)

func (*OpenAPI) NewResponse

func (oa *OpenAPI) NewResponse(desc string, v string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]

func (*OpenAPI) NewSimpleParam

func (oa *OpenAPI) NewSimpleParam(element *astp.Element, tag string) *spec.RefOrSpec[spec.Extendable[spec.Parameter]]

func (*OpenAPI) NewStringProp

func (oa *OpenAPI) NewStringProp(prop *spec.RefOrSpec[spec.Schema], typeString string) (isArray bool, sa spec.SingleOrArray[string])

func (*OpenAPI) NewStringResponse

func (oa *OpenAPI) NewStringResponse(desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]

func (*OpenAPI) Print

func (oa *OpenAPI) Print(slot string)

func (*OpenAPI) WriteOut

func (oa *OpenAPI) WriteOut() error