go-zero创建RESTful API 服务的方法

go install github.com/zeromicro/go-zero/tools/goctl@latest

goctl api new user

user/
├── etc/                   # 配置文件
│   └── user-api.yaml      # API 服务配置
├── user.api               # API 定义文件
├── go.mod                 # Go 模块文件
├── internal/
│   ├── config/            # 配置文件的结构体定义
│   │   └── config.go
│   ├── handler/           # HTTP 路由处理器
│   │   ├── createuserhandler.go
│   │   └── routes.go      # 路由定义文件
│   ├── logic/             # 业务逻辑
│   │   └── createuserlogic.go
│   ├── svc/               # 服务上下文
│   │   └── servicecontext.go
│   └── types/             # 请求和响应数据结构
│       └── types.go
└── main.go                # 主程序入口

syntax = "v1";
info(
    title: "User API"
    desc: "User service API"
    version: "1.0"
)
type (
    UserRequest {
        name string
        age  int
    }
    UserResponse {
        id   int
        name string
        age  int
    }
)
service user {
    @handler CreateUser
    post /api/v1/user (UserRequest) returns (UserResponse)
}

goctl api go -api user.api -dir .

package logic
import (
    "context"
    "project-name/internal/svc"
    "project-name/internal/types"
    "github.com/zeromicro/go-zero/core/logx"
)
type CreateUserLogic struct {
    logx.Logger
    ctx    context.Context
    svcCtx *svc.ServiceContext
}
func NewCreateUserLogic(ctx context.Context, svcCtx *svc.ServiceContext) *CreateUserLogic {
    return &CreateUserLogic{
        Logger: logx.WithContext(ctx),
        ctx:    ctx,
        svcCtx: svcCtx,
    }
}
func (l *CreateUserLogic) CreateUser(req *types.UserRequest) (resp *types.UserResponse, err error) {
    // 假设逻辑是简单地返回请求的内容，并附加一个 id
    resp = &types.UserResponse{
        id:   1,
        name: req.Name,
        age:  req.Age,
    }
    return resp, nil
}

package handler
import (
    "net/http"
    "github.com/zeromicro/go-zero/rest/httpx"
    "project-name/internal/logic"
    "project-name/internal/svc"
    "project-name/internal/types"
)
func RegisterHandlers(svcCtx *svc.ServiceContext) {
    http.HandleFunc("/api/v1/user", func(w http.ResponseWriter, r *http.Request) {
        var req types.UserRequest
        if err := httpx.Parse(r, &req); err != nil {
            httpx.Error(w, err)
            return
        }
        l := logic.NewCreateUserLogic(r.Context(), svcCtx)
        resp, err := l.CreateUser(&req)
        if err != nil {
            httpx.Error(w, err)
        } else {
            httpx.OkJson(w, resp)
        }
    })
}

Name: user-api
Host: 0.0.0.0
Port: 8080

package main
import (
    "flag"
    "fmt"
    "project-name/internal/config"
    "project-name/internal/handler"
    "project-name/internal/svc"
    "github.com/zeromicro/go-zero/core/conf"
    "github.com/zeromicro/go-zero/rest"
)
var configFile = flag.String("f", "etc/user-api.yaml", "the config file")
func main() {
    flag.Parse()
    var c config.Config
    conf.MustLoad(*configFile, &c)
    server := rest.MustNewServer(c.RestConf)
    defer server.Stop()
    ctx := svc.NewServiceContext(c)
    handler.RegisterHandlers(ctx)
    fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
    server.Start()
}

go run main.go -f etc/user-api.yaml

curl -X POST -d '{"name":"Alice","age":25}' http://localhost:8080/api/v1/user

{
    "id": 1,
    "name": "Alice",
    "age": 25
}