Skip to content
go-zero
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Select language
English
简体中文
Concepts
Concepts
Architecture
Design Principles
Project Structure
Glossary
Getting Started
Getting Started
installation
Installation
Install Go
Install goctl
Install protoc
IDE Plugins
Project Creation Methods
Guides
Guides
Quick Start
Quick Start
Hello World
Create an API Service
Create an RPC Service
HTTP Service
server
HTTP Server
HTTP Server Configuration
Middleware
Error Handling
Request Body
Response Body
Response Extensions
Server-Sent Events
HTTP Guide
Basic HTTP Service
client
HTTP Client
JWT Authentication
File Upload
gRPC Service
client
gRPC Client Configuration
gRPC Client
gRPC Client Connection
server
gRPC Server
gRPC Server Configuration
gRPC Server Example
gRPC Guide
gRPC Interceptors
Database
MySQL
Redis
MongoDB
Database Read-Write Splitting
Database Guide
Microservice
Service Discovery
Load Balancing
Distributed Tracing
Microservice Guide
Message Queue
Kafka Queue
Beanstalkd Queue
Queue Guide
API Gateway
API Gateway Guide
gRPC Gateway
HTTP Gateway
Deployment
Docker
Kubernetes
Deployment Guide
Cron Job
Cron Jobs
Cron Jobs on Kubernetes
MCP Integration
AI-Assisted go-zero Development
MCP Guide
MCP Servers
Components
Components
Cache
Memory Cache
Redis Cache
Cache Components
Resilience
Circuit Breaker
Period Limiter
Rate Limiter
Token Bucket Limiter
Timeout
Load Shedding
Resilience Components
Concurrency
FX Pipeline
MapReduce
Concurrency
syncx Limit
Log
logx
Log Desensitization
logc
Log Components
Observability
Metrics
Continuous Profiling
Tracing
Observability Components
Queue
Kafka
RabbitMQ
Queue Components
Reference
Reference
DSL Syntax
DSL Syntax
API DSL Syntax
Proto Syntax for go-zero
API DSL
API Route Rules
API Route Groups
API Route Prefix
API DSL Reference
API Types
API Parameters
API Middleware Declaration
API JWT Auth
Request Signing
API Import
SSE Routes
API FAQ
Proto DSL
Proto Spec
Services Grouping
Proto FAQ
Proto DSL Reference
goctl CLI
goctl Overview
goctl Quickstart
goctl CLI Reference
goctl API
goctl RPC
goctl Model
goctl Docker
goctl Kubernetes
goctl Environment
goctl Configuration
goctl Template
goctl Style
goctl Swagger
goctl Upgrade
goctl Migrate
Shell Completion
goctl Bug Report
goctl
goctl Commands
goctl Reference
API Generation
RPC Generation
Model Generation
Configuration Reference
Configuration Reference
API Service Configuration
RPC Service Configuration
Configuration Guide
Configuration Overview
Service Configuration
Log Configuration
Prometheus Configuration
Config Auto-Validation
Configuration Guide
Customization
Customization
Template Customization
goctl Plugins
Changelog
Releases
Release Notes
v1.10.0
v1.9.4
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.8.5
v1.8.4
v1.8.3
v1.8.2
v1.8.1
v1.8.0
v1.7.6
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.5.6
v1.5.5
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.5
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
Community
Community
Code Style
Pull Request Process
Documentation
Contributors
FAQ
FAQ
Installation FAQ
deploy
Deployment FAQ
Reducing Binary Size
http
HTTP FAQ
CORS Configuration
File Server
log
Logging FAQ
Log to File and Console
goctl FAQ
Examples
Examples
Hello World
REST API with JWT
Bookstore
Microservice System
GitHub
Select theme
Dark
Light
Auto
Select language
English
简体中文
DSL Syntax
Specifications
Section titled “Specifications”
API Syntax
— The
.api
file format for defining HTTP services
Proto Syntax
— Proto conventions and goctl-specific extensions
