fw_openapi

package module

v0.1.5 Latest Latest Go to latest Published: Dec 3, 2024 License: MIT Imports: 11 Imported by: 0

Details

generate openapi documents from linxlib/astp

This section is empty.

This section is empty.

This section is empty.

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

func NewOpenAPIFromFWServer(s *fw.Server) *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, resp *spec.RefOrSpec[spec.Extendable[spec.Response]])

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

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

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) 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) (*spec.RefOrSpec[spec.Schema], 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) NewStringResponse(desc string, contentType string) *spec.RefOrSpec[spec.Extendable[spec.Response]]

func (oa *OpenAPI) Print(slot string)

func (oa *OpenAPI) WriteOut() error

Path	Synopsis
middleware