Struttura di Goa
Design-first API development with automatic code generation for Go microservices.
Documentazione
LLM-optimized documentation for Goa and Goa-AI frameworks. Consolidated pages designed for easy copying into LLM contexts.
Sezioni della documentazione
Questa documentazione è organizzata in pagine consolidate e autonome, ottimizzate per il consumo di LLM. Ogni pagina può essere copiata per intero per fornire un contesto completo.
Struttura Goa
Sviluppo di API orientato alla progettazione con generazione automatica di codice per microservizi Go.
| Guida | Descrizione | ~Tokens |
|---|---|---|
| Quickstart | Installate Goa e costruite il vostro primo servizio | ~1.100 |
| DSL Reference | Riferimento completo per il linguaggio di progettazione di Goa | ~2.900 |
| Code Generation | Comprendere il processo di generazione del codice di Goa | ~2.100 |
| Guida HTTP | Caratteristiche del trasporto HTTP, routing e pattern | ~1.700 |
| Guida gRPC | Caratteristiche del trasporto gRPC e streaming | ~1,800 |
| Gestione degli errori | Definizione e gestione degli errori | ~1.800 |
| Intercettatori | Intercettatori e modelli di middleware | ~1.400 |
| Produzione | Osservabilità, sicurezza e distribuzione | ~1.300 |
Totale sezione Goa: ~14.500 gettoni
Struttura Goa-AI
Framework orientato alla progettazione per la costruzione di sistemi agici e guidati da strumenti in Go.
| Guida | Descrizione | ~Tokens |
|---|---|---|
| Quickstart | Installazione e primo agente | ~2,700 |
| DSL Reference | DSL completo: agenti, toolset, policy, MCP | ~3.600 |
| Runtime | Architettura del runtime, ciclo di pianificazione/esecuzione, motori | ~2,400 |
| Toolsets | Tipi di toolset, modelli di esecuzione, trasformazioni | ~2,300 |
| Agent Composition | Agent-as-tool, alberi di esecuzione, topologia di streaming | ~1.400 |
| Integrazione MCP | Server MCP, trasporti, wrapper generati | ~1.200 |
| Memoria e sessioni | Trascrizioni, archivi di memoria, sessioni, esecuzioni | ~1.600 |
| Produzione | Impostazione temporale, UI in streaming, integrazione del modello | ~2.200 |
Totale sezione Goa-AI: ~17.600 gettoni
Utilizzo di questa documentazione con gli LLM
Funzione di copia della pagina
Ogni pagina di documentazione include un pulsante “Copia pagina” con due opzioni:
- Copia come Markdown - Conserva la formattazione, le annotazioni linguistiche dei blocchi di codice e la gerarchia delle intestazioni
- Copia come testo normale - Testo pulito senza sintassi markdown, adatto a qualsiasi contesto
Flusso di lavoro consigliato
- Iniziare con il Quickstart - Copiare la guida rapida per dare un contesto di base al proprio LLM
- Aggiungi guide specifiche - Copia le guide pertinenti in base alla tua attività (ad esempio, la guida HTTP per le API REST)
- Includere il riferimento al DSL - Per le domande di progettazione, includere il riferimento al DSL completo
Suggerimenti per il budget dei token
- Ogni guida è progettata per adattarsi alle finestre di contesto tipiche di un LLM
- La documentazione completa di Goa (~14,5k tokens) si adatta facilmente alla maggior parte degli LLM moderni
- La documentazione completa di Goa-AI (~17,6k tokens) è altrettanto compatta
- Entrambi i framework insieme (~32k tokens) funzionano bene con modelli di contesto più grandi
Concetti chiave
Sviluppo orientato al design
Sia Goa che Goa-AI seguono una filosofia design-first:
- Definire la propria API/Agent utilizzando un potente DSL
- Generare codice automaticamente dal progetto
- Implementare la logica di business in interfacce pulite e sicure dal punto di vista tipologico
- La documentazione rimane sincronizzata perché proviene dalla stessa fonte
Sicurezza dei tipi
Il codice generato offre una sicurezza di tipo end-to-end:
// Generated interface - your contract
type Service interface {
Add(context.Context, *AddPayload) (int, error)
}
// Your implementation - clean and focused
func (s *service) Add(ctx context.Context, p *calc.AddPayload) (int, error) {
return p.A + p.B, nil
}
Comunità
- Gophers Slack - Canale #goa
- Discussioni GitHub - Domande e idee
- Bluesky - Aggiornamenti e annunci
Contribuire
Volete migliorare la documentazione? Consulta la Guida al contributo per le linee guida sulle case canoniche, i modelli di collegamento incrociato e la strategia dei contenuti.