Versions in this module Expand all Collapse all v6 v6.0.1 Jan 8, 2020 v6.0.0 Jan 7, 2020 Changes in this version + const Bool + const None + const Number + const Object + const RichtextTypeHTML + const RichtextTypeMarkdown + const String + func Valid(content []byte) error + type API struct + Callback *Callback + Deprecated Version + Description Richtext + Headers []*Param + ID string + Method Method + Path *Path + Requests []*Request + Responses []*Request + Servers []string + Summary string + Tags []string + Version Version + XMLName struct{} + func (api *API) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Callback struct + Deprecated Version + Description Richtext + Headers []*Param + Method Method + Path *Path + Reference string + Requests []*Request + Responses []*Request + Summary string + func (c *Callback) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Contact struct + Email string + Name string + URL string + func (c *Contact) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Doc struct + APIDoc string + Apis []*API + Contact *Contact + Created string + Description Richtext + Lang string + License *Link + Logo string + Mimetypes []string + Responses []*Request + Servers []*Server + Tags []*Tag + Title string + Version Version + XMLName struct{} + func New() *Doc + func (doc *Doc) FromXML(file string, line int, data []byte) error + func (doc *Doc) NewAPI(file string, line int, data []byte) error + func (doc *Doc) Sanitize() error + func (doc *Doc) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Enum struct + Deprecated Version + Description Richtext + Summary string + Value string + func (e *Enum) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Example struct + Content string + Description Richtext + Mimetype string + Summary string + func (e *Example) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Link struct + Text string + URL string + func (l *Link) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Method string + func (m *Method) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + func (m *Method) UnmarshalXMLAttr(attr xml.Attr) error + func (m Method) MarshalXML(e *xml.Encoder, start xml.StartElement) error + func (m Method) MarshalXMLAttr(name xml.Name) (xml.Attr, error) + type Param struct + Array bool + Default string + Deprecated Version + Description Richtext + Enums []*Enum + Items []*Param + Name string + Optional bool + Reference string + Summary string + Type Type + func (p *Param) IsEnum() bool + func (p *Param) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Path struct + Params []*Param + Path string + Queries []*Param + Reference string + func (p *Path) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Request struct + Array bool + Deprecated Version + Description Richtext + Enums []*Enum + Examples []*Example + Headers []*Param + Items []*Param + Mimetype string + Name string + Reference string + Status Status + Summary string + Type Type + func (r *Request) IsEnum() bool + func (r *Request) Param() *Param + func (r *Request) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Richtext struct + Text string + Type string + func (text *Richtext) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + func (text Richtext) MarshalXML(e *xml.Encoder, start xml.StartElement) error + type Server struct + Deprecated Version + Description Richtext + Name string + Summary string + URL string + func (srv *Server) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Status int + func (s *Status) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + func (s *Status) UnmarshalXMLAttr(attr xml.Attr) error + func (s Status) MarshalXML(e *xml.Encoder, start xml.StartElement) error + func (s Status) MarshalXMLAttr(name xml.Name) (xml.Attr, error) + func (s Status) String() string + type Tag struct + Deprecated Version + Name string + Title string + func (t *Tag) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + type Type string + func (t *Type) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + func (t *Type) UnmarshalXMLAttr(attr xml.Attr) error + func (t Type) MarshalXML(e *xml.Encoder, start xml.StartElement) error + func (t Type) MarshalXMLAttr(name xml.Name) (attr xml.Attr, err error) + type Version string + func (v *Version) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error + func (v *Version) UnmarshalXMLAttr(attr xml.Attr) error + func (v Version) MarshalXML(e *xml.Encoder, start xml.StartElement) error + func (v Version) MarshalXMLAttr(name xml.Name) (xml.Attr, error) + type XML struct + XMLAttr bool + XMLExtract bool + XMLNS string + XMLNSPrefix string + XMLWrapped string Other modules containing this package github.com/caixw/apidoc/v5
Go to main page