Cadre de Goa
Design-first API development with automatic code generation for Go microservices.
Documentation
LLM-optimized documentation for Goa and Goa-AI frameworks. Consolidated pages designed for easy copying into LLM contexts.
Sections de la documentation
Cette documentation est organisée en pages consolidées et autonomes, optimisées pour la consommation de LLM. Chaque page peut être copiée dans son intégralité pour fournir un contexte complet.
Cadre Goa
Développement d’API avec génération automatique de code pour les microservices Go.
| Guide de l’utilisateur - Description - ~Tokens - ~Tokens - ~Tokens - ~Tokens - ~Tokens | ||
|---|---|---|
| Quickstart | Installez Goa et construisez votre premier service | |
| Référence DSL](1-goa/dsl-reference/) | Référence complète pour le langage de conception de Goa | ~2 900 |
| Génération de code | Comprendre le processus de génération de code de Goa | ~2,100 |
| Guide HTTP](1-goa/http-guide/) | Caractéristiques, routage et modèles du transport HTTP | ~1 700 |
| Guide gRPC](1-goa/grpc-guide/) | Fonctionnalités de transport gRPC et streaming | ~1,800 |
| Gestion des erreurs | Définition et gestion des erreurs | ~1 800 |
| Intercepteurs | Intercepteurs et modèles d’intergiciels | ~1 400 |
| Production](1-goa/production/) | Observabilité, sécurité et déploiement | ~1 300 |
Total de la section Goa: ~14 500 jetons
Goa-AI Framework
Cadre de conception pour la construction de systèmes agentiques pilotés par des outils en Go.
| Guide de l’utilisateur - Description - ~Tokens - ~Tokens - ~Tokens - ~Tokens - ~Tokens | ||
|---|---|---|
| Installation et premier agent | ~2 700 | |
| DSL Reference](2-goa-ai/dsl-reference/) | DSL complet : agents, toolsets, policies, MCP | ~3,600 |
| Runtime | Architecture du runtime, boucle plan/execute, moteurs | ~2,400 |
| Outils | Types d’outils, modèles d’exécution, transformations | ~2 300 |
| Composition de l’agent](2-goa-ai/agent-composition/) | Agent en tant qu’outil, arbres d’exécution, topologie de streaming | ~1,400 |
| Intégration MCP | Serveurs MCP, transports, wrappers générés | ~1.200 |
| Mémoire et sessions | Transcriptions, mémoires, sessions, exécutions | ~1.600 |
| Production | Configuration temporelle, interface utilisateur en continu, intégration de modèles | ~2 200 |
Total de la section Goa-AI: ~17 600 jetons
Utilisation de cette documentation avec les LLM
Fonctionnalité de copie de page
Chaque page de documentation comprend un bouton “Copier la page” avec deux options :
- Copier en Markdown - Préserve le formatage, les annotations de langage des blocs de code et la hiérarchie des titres
- Copier en texte brut - Texte propre sans syntaxe Markdown, adapté à tous les contextes
Flux de travail recommandé
- Commencez par le Quickstart - Copiez le guide de démarrage rapide pour donner à votre LLM un contexte de base
- Ajouter des guides spécifiques - Copiez les guides pertinents en fonction de votre tâche (par exemple, le guide HTTP pour les API REST)
- Inclure la référence DSL - Pour les questions de conception, inclure la référence DSL complète
Conseils sur le budget des jetons
- Chaque guide est conçu pour s’intégrer dans les fenêtres contextuelles typiques des LLM
- La documentation complète de Goa (~14,5k tokens) s’intègre facilement dans la plupart des LLM modernes
- La documentation complète de Goa-AI (~17.6k tokens) est également compacte
- Les deux frameworks ensemble (~32k tokens) fonctionnent bien avec des modèles de contexte plus larges
Concepts clés
Développement axé sur la conception d’abord
Goa et Goa-AI suivent tous deux une philosophie de conception d’abord :
- Définissez votre API/Agent à l’aide d’un puissant DSL
- Générer du code automatiquement à partir de votre conception
- Implémenter la logique métier dans des interfaces propres et sûres
- La documentation reste synchronisée car elle provient de la même source
Sécurité de type
Le code généré offre une sécurité de type de bout en bout :
// 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
}
Communauté
- Gophers Slack - Canal #goa
- GitHub Discussions - Questions et idées
- Bluesky - Mises à jour et annonces
Contribuer
Vous souhaitez améliorer la documentation ? Consultez le Guide de contribution pour obtenir des directives sur les maisons canoniques, les modèles de liens croisés et la stratégie de contenu.