swagger

Documentation

Index

• type Generator
  • func New(title, ver, desc string) *Generator
  • func (sg *Generator) ReDocUI(svc ...desc.ServiceDesc) (fs.FS, error)
  • func (sg *Generator) SwaggerUI(svc ...desc.ServiceDesc) (fs.FS, error)
  • func (sg *Generator) WithTag(tagName string) *Generator
  • func (sg *Generator) WritePostmanTo(w io.Writer, descs ...desc.ServiceDesc) error
  • func (sg *Generator) WritePostmanToFile(filename string, services ...desc.ServiceDesc) error
  • func (sg *Generator) WriteSwagTo(w io.Writer, descs ...desc.ServiceDesc) error
  • func (sg *Generator) WriteSwagToFile(filename string, services ...desc.ServiceDesc) error

Examples

• Generator.WritePostmanToFile
• Generator.WriteSwagToFile

Types

type Generator

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

func New

func New(title, ver, desc string) *Generator

func (*Generator) ReDocUI

func (sg *Generator) ReDocUI(svc ...desc.ServiceDesc) (fs.FS, error)

func (*Generator) SwaggerUI

func (sg *Generator) SwaggerUI(svc ...desc.ServiceDesc) (fs.FS, error)

func (*Generator) WithTag

func (sg *Generator) WithTag(tagName string) *Generator

func (*Generator) WritePostmanTo

func (sg *Generator) WritePostmanTo(w io.Writer, descs ...desc.ServiceDesc) error

func (*Generator) WritePostmanToFile

func (sg *Generator) WritePostmanToFile(filename string, services ...desc.ServiceDesc) error

Example

err := swagger.New("TestTitle", "v0.0.1", "").
	WithTag("json").
	WritePostmanToFile("_postman.json", testService{})
fmt.Println(err)

Output:

<nil>

func (*Generator) WriteSwagTo

func (sg *Generator) WriteSwagTo(w io.Writer, descs ...desc.ServiceDesc) error

func (*Generator) WriteSwagToFile

func (sg *Generator) WriteSwagToFile(filename string, services ...desc.ServiceDesc) error

Example

err := swagger.New("TestTitle", "v0.0.1", "").
	WithTag("json").
	WriteSwagToFile("_swagger.json", testService{})
fmt.Println(err)

Output:

<nil>