Documentation
¶
Overview ¶
Package docs provides documentation generation utilities.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIDoc ¶
type APIDoc struct {
Title string
Description string
Version string
BasePath string
Endpoints []Endpoint
}
APIDoc represents API documentation.
func (*APIDoc) AddEndpoint ¶
AddEndpoint adds an endpoint.
func (*APIDoc) GenerateOpenAPI ¶
GenerateOpenAPI generates OpenAPI 3.0 specification.
func (*APIDoc) MarkdownDocs ¶
MarkdownDocs generates Markdown documentation.
type ArchitectureDoc ¶
ArchitectureDoc represents architecture documentation.
func ArchitectureOverview ¶
func ArchitectureOverview() *ArchitectureDoc
ArchitectureOverview returns the main architecture document.
func NewArchitectureDoc ¶
func NewArchitectureDoc(title string) *ArchitectureDoc
NewArchitectureDoc creates architecture documentation.
func (*ArchitectureDoc) AddSection ¶
func (a *ArchitectureDoc) AddSection(title string, level int, content string)
AddSection adds a section.
func (*ArchitectureDoc) GenerateMarkdown ¶
func (a *ArchitectureDoc) GenerateMarkdown() string
GenerateMarkdown creates Markdown documentation.
type Endpoint ¶
type Endpoint struct {
Path string
Method string
Summary string
Description string
Parameters []Parameter
RequestBody interface{}
Response map[string]interface{}
Security []string
}
Endpoint represents an API endpoint.
Click to show internal directories.
Click to hide internal directories.