docs

package
v0.0.0-...-56f785d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2025 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIEndpoint 

type APIEndpoint struct {
	ID          string                 `json:"id"`
	Name        string                 `json:"name"`
	Method      string                 `json:"method"`
	Path        string                 `json:"path"`
	Description string                 `json:"description"`
	Parameters  []*Parameter           `json:"parameters,omitempty"`
	RequestBody *RequestBodySpec       `json:"request_body,omitempty"`
	Responses   map[string]*Response   `json:"responses"`
	Examples    []*APIExample          `json:"examples,omitempty"`
	Performance *PerformanceInfo       `json:"performance,omitempty"`
	Security    []string               `json:"security,omitempty"`
	Tags        []string               `json:"tags,omitempty"`
	Deprecated  bool                   `json:"deprecated,omitempty"`
	Since       string                 `json:"since,omitempty"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
}

APIEndpoint はAPIエンドポイント情報

type APIExample 

type APIExample struct {
	ID          string                 `json:"id"`
	Title       string                 `json:"title"`
	Description string                 `json:"description"`
	Language    string                 `json:"language"`
	Request     *ExampleRequest        `json:"request"`
	Response    *ExampleResponse       `json:"response"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
}

APIExample はAPI使用例

type AutoDocumentationGenerator 

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

AutoDocumentationGenerator は自動文書生成システム

func NewAutoDocumentationGenerator 

func NewAutoDocumentationGenerator(cfg *config.Config) *AutoDocumentationGenerator

NewAutoDocumentationGenerator は新しい自動文書生成器を作成

func (*AutoDocumentationGenerator) Generate 

func (g *AutoDocumentationGenerator) Generate() error

Generate は全ての文書を生成

type BenchmarkMetric 

type BenchmarkMetric struct {
	Duration    time.Duration `json:"duration"`
	Throughput  float64       `json:"throughput_mbps"`
	MemoryUsage int64         `json:"memory_usage_mb"`
	CPUUsage    float64       `json:"cpu_usage_percent"`
	ErrorRate   float64       `json:"error_rate_percent"`
	SuccessRate float64       `json:"success_rate_percent"`
}

BenchmarkMetric はベンチマーク指標

type BenchmarkResult 

type BenchmarkResult struct {
	Name              string                 `json:"name"`
	Description       string                 `json:"description"`
	TraditionalTool   *BenchmarkMetric       `json:"traditional_tool"`
	S3ry              *BenchmarkMetric       `json:"s3ry"`
	ImprovementFactor float64                `json:"improvement_factor"`
	TestConditions    map[string]interface{} `json:"test_conditions"`
	LastUpdated       time.Time              `json:"last_updated"`
}

BenchmarkResult はベンチマーク結果

type Change 

type Change struct {
	Type        string   `json:"type"` // "added", "changed", "deprecated", "removed", "fixed", "security"
	Description string   `json:"description"`
	Components  []string `json:"components,omitempty"`
	Issues      []string `json:"issues,omitempty"`
	Breaking    bool     `json:"breaking,omitempty"`
}

Change は個別の変更

type ChangelogEntry 

type ChangelogEntry struct {
	Version     string                 `json:"version"`
	Date        time.Time              `json:"date"`
	Title       string                 `json:"title"`
	Description string                 `json:"description"`
	Changes     []*Change              `json:"changes"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
}

ChangelogEntry は変更履歴エントリ

type CodeExample 

type CodeExample struct {
	ID          string                 `json:"id"`
	Title       string                 `json:"title"`
	Description string                 `json:"description"`
	Language    string                 `json:"language"`
	Code        string                 `json:"code"`
	Output      string                 `json:"output,omitempty"`
	Category    string                 `json:"category"`
	Difficulty  string                 `json:"difficulty"`
	Tags        []string               `json:"tags,omitempty"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
}

CodeExample はコード例

type DocumentationSection 

type DocumentationSection struct {
	ID          string                  `json:"id"`
	Title       string                  `json:"title"`
	Description string                  `json:"description"`
	Order       int                     `json:"order"`
	Content     string                  `json:"content"`
	Subsections []*DocumentationSection `json:"subsections,omitempty"`
	Examples    []*CodeExample          `json:"examples,omitempty"`
	APIRefs     []string                `json:"api_refs,omitempty"`
	Metadata    map[string]interface{}  `json:"metadata,omitempty"`
	Tags        []string                `json:"tags,omitempty"`
	LastUpdated time.Time               `json:"last_updated"`
}

DocumentationSection は文書セクション

type Encoding 

type Encoding struct {
	ContentType string             `json:"content_type,omitempty"`
	Headers     map[string]*Header `json:"headers,omitempty"`
	Style       string             `json:"style,omitempty"`
	Explode     bool               `json:"explode,omitempty"`
}

Encoding はエンコーディング情報

type Example 

type Example struct {
	Summary     string      `json:"summary,omitempty"`
	Description string      `json:"description,omitempty"`
	Value       interface{} `json:"value"`
}

Example はサンプルデータ

type ExampleRequest 

type ExampleRequest struct {
	Method  string                 `json:"method"`
	URL     string                 `json:"url"`
	Headers map[string]string      `json:"headers,omitempty"`
	Body    interface{}            `json:"body,omitempty"`
	Params  map[string]interface{} `json:"params,omitempty"`
}

ExampleRequest はリクエスト例

type ExampleResponse 

type ExampleResponse struct {
	Status  int               `json:"status"`
	Headers map[string]string `json:"headers,omitempty"`
	Body    interface{}       `json:"body,omitempty"`
}

ExampleResponse はレスポンス例 

type Header struct {
	Description string      `json:"description"`
	Schema      *Schema     `json:"schema,omitempty"`
	Example     interface{} `json:"example,omitempty"`
}

Header はレスポンスヘッダー

type MediaTypeSpec 

type MediaTypeSpec struct {
	Schema   *Schema              `json:"schema"`
	Example  interface{}          `json:"example,omitempty"`
	Examples map[string]*Example  `json:"examples,omitempty"`
	Encoding map[string]*Encoding `json:"encoding,omitempty"`
}

MediaTypeSpec はメディアタイプ仕様

type OptimizationTechnique 

type OptimizationTechnique struct {
	ID             string   `json:"id"`
	Name           string   `json:"name"`
	Description    string   `json:"description"`
	Category       string   `json:"category"`
	Impact         string   `json:"impact"`
	Implementation string   `json:"implementation"`
	Benefits       []string `json:"benefits"`
	Drawbacks      []string `json:"drawbacks,omitempty"`
	UseCases       []string `json:"use_cases"`
}

OptimizationTechnique は最適化技法

type Parameter 

type Parameter struct {
	Name        string      `json:"name"`
	In          string      `json:"in"` // "query", "header", "path", "body"
	Type        string      `json:"type"`
	Required    bool        `json:"required"`
	Description string      `json:"description"`
	Default     interface{} `json:"default,omitempty"`
	Example     interface{} `json:"example,omitempty"`
	Validation  *Validation `json:"validation,omitempty"`
}

Parameter はAPIパラメーター

type PerformanceComparison 

type PerformanceComparison struct {
	ToolName      string                 `json:"tool_name"`
	Version       string                 `json:"version"`
	Metrics       *BenchmarkMetric       `json:"metrics"`
	Advantages    []string               `json:"advantages"`
	Disadvantages []string               `json:"disadvantages"`
	UseCases      []string               `json:"use_cases"`
	Metadata      map[string]interface{} `json:"metadata,omitempty"`
}

PerformanceComparison はパフォーマンス比較

type PerformanceDocumentation 

type PerformanceDocumentation struct {
	OverallImprovement float64                           `json:"overall_improvement"`
	BenchmarkResults   map[string]*BenchmarkResult       `json:"benchmark_results"`
	Optimizations      []*OptimizationTechnique          `json:"optimizations"`
	PerformanceTips    []*PerformanceTip                 `json:"performance_tips"`
	Comparisons        map[string]*PerformanceComparison `json:"comparisons"`
	Metrics            *PerformanceMetrics               `json:"metrics"`
}

PerformanceDocumentation はパフォーマンス文書

type PerformanceInfo 

type PerformanceInfo struct {
	AverageDuration   string   `json:"average_duration"`
	Throughput        string   `json:"throughput,omitempty"`
	ImprovementFactor float64  `json:"improvement_factor,omitempty"`
	Benchmarks        []string `json:"benchmarks,omitempty"`
	Optimizations     []string `json:"optimizations,omitempty"`
}

PerformanceInfo はパフォーマンス情報

type PerformanceMetrics 

type PerformanceMetrics struct {
	TotalOperations   int64     `json:"total_operations"`
	AverageThroughput float64   `json:"average_throughput_mbps"`
	PeakThroughput    float64   `json:"peak_throughput_mbps"`
	TotalDataTransfer int64     `json:"total_data_transfer_gb"`
	AverageLatency    float64   `json:"average_latency_ms"`
	SuccessRate       float64   `json:"success_rate_percent"`
	UptimePercentage  float64   `json:"uptime_percentage"`
	LastUpdated       time.Time `json:"last_updated"`
}

PerformanceMetrics はパフォーマンス指標

type PerformanceTip 

type PerformanceTip struct {
	ID           string   `json:"id"`
	Title        string   `json:"title"`
	Description  string   `json:"description"`
	Category     string   `json:"category"`
	Priority     string   `json:"priority"`
	Steps        []string `json:"steps"`
	Example      string   `json:"example,omitempty"`
	ExpectedGain string   `json:"expected_gain"`
}

PerformanceTip はパフォーマンスチップ

type RequestBodySpec 

type RequestBodySpec struct {
	Description string                    `json:"description"`
	Required    bool                      `json:"required"`
	Content     map[string]*MediaTypeSpec `json:"content"`
}

RequestBodySpec はリクエストボディ仕様

type Response 

type Response struct {
	Description string                    `json:"description"`
	Headers     map[string]*Header        `json:"headers,omitempty"`
	Content     map[string]*MediaTypeSpec `json:"content,omitempty"`
}

Response はAPIレスポンス

type Schema 

type Schema struct {
	Type        string             `json:"type"`
	Format      string             `json:"format,omitempty"`
	Description string             `json:"description,omitempty"`
	Properties  map[string]*Schema `json:"properties,omitempty"`
	Items       *Schema            `json:"items,omitempty"`
	Required    []string           `json:"required,omitempty"`
	Example     interface{}        `json:"example,omitempty"`
}

Schema はデータスキーマ

type Tutorial 

type Tutorial struct {
	ID            string                 `json:"id"`
	Title         string                 `json:"title"`
	Description   string                 `json:"description"`
	Level         string                 `json:"level"` // "beginner", "intermediate", "advanced"
	EstimatedTime string                 `json:"estimated_time"`
	Prerequisites []string               `json:"prerequisites,omitempty"`
	Steps         []*TutorialStep        `json:"steps"`
	Resources     []*TutorialResource    `json:"resources,omitempty"`
	Tags          []string               `json:"tags,omitempty"`
	Metadata      map[string]interface{} `json:"metadata,omitempty"`
	CreatedAt     time.Time              `json:"created_at"`
	UpdatedAt     time.Time              `json:"updated_at"`
}

Tutorial はチュートリアル

type TutorialResource 

type TutorialResource struct {
	Type        string `json:"type"` // "link", "file", "video", "documentation"
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	URL         string `json:"url,omitempty"`
	FilePath    string `json:"file_path,omitempty"`
}

TutorialResource はチュートリアルリソース

type TutorialStep 

type TutorialStep struct {
	Number      int      `json:"number"`
	Title       string   `json:"title"`
	Description string   `json:"description"`
	Code        string   `json:"code,omitempty"`
	Output      string   `json:"output,omitempty"`
	Explanation string   `json:"explanation,omitempty"`
	Tips        []string `json:"tips,omitempty"`
	Warnings    []string `json:"warnings,omitempty"`
	NextSteps   []string `json:"next_steps,omitempty"`
}

TutorialStep はチュートリアルステップ

type Validation 

type Validation struct {
	MinLength *int     `json:"min_length,omitempty"`
	MaxLength *int     `json:"max_length,omitempty"`
	Min       *float64 `json:"min,omitempty"`
	Max       *float64 `json:"max,omitempty"`
	Pattern   string   `json:"pattern,omitempty"`
	Enum      []string `json:"enum,omitempty"`
}

Validation はパラメーター検証ルール

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.