documents

package

v0.11.1 Latest Latest Go to latest Published: Nov 1, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

Builder 独立子文档构建器

func NewBuilder(config *goswagger.Swagger, serviceSpecs map[string]map[string]interface{}, lastUpdated time.Time, logger logger.ILogger) *Builder

NewBuilder 创建独立子文档构建器

func (b *Builder) BuildAll() error

BuildAll 构建全部独立子文档

func (b *Builder) GetDocumentSpec(documentName string) ([]byte, error)

GetDocumentSpec 获取独立文档规范 JSON

func (b *Builder) GetDocumentSpecs() map[string]map[string]interface{}

GetDocumentSpecs 获取所有已构建的文档规范

func (b *Builder) GetDocumentSummaries() []DocumentSummary

GetDocumentSummaries 收集文档列表页所需摘要

func (b *Builder) ResolveSpecTitle(spec map[string]interface{}, fallback string) string

ResolveSpecTitle 从规范中解析标题，失败时返回 fallback

type DocumentSummary struct {
	Name        string
	Title       string
	Description string
	Version     string
	Services    []string
}

DocumentSummary 独立文档摘要，用于列表页展示