用户工具

站点工具


教程:kratos:api定义

这是本文档旧的修订版!


API定义

要使用Kratos定义API主要有如下步骤1)2):

  1. 生成 proto 模板
  2. 生成 client源码
  3. 生成 server 源码

生成proto模板

使用如下命令:

kratos proto add api/user/v1/user.proto

该命令就生成proto模板文件,我们在这个模板文件中定义对应的 REST API 和 gRPC API

生成client模板

使用如下命令,我们就能根据上一步得到的proto模板生成client模板:

kratos proto client api/user/v1/user.proto

生成成功后就可以看到如下的文件树(*为生成的文件):

├── api
│   └── user
│       └── v1
│           ├── user_grpc.pb.go*
│           ├── user_http.pb.go*
│           ├── user.pb.go*
│           └── user.proto

可以发现kratos在”api/user/v1”目录下生成了”user.pb.go”,”user_http.pb.go”和”user_grpc.pb.go”三个文件

生成server模板

使用如下命令生成server模板:

kratos proto server api/user/v1/user.proto -t internal/service

执行后会生成”/internal/service/user.go”的server模板,文件树如下(*为生成的文件):

├── internal
│ ......
│   └── service
│       ├── README.md
│       ├── service.go
│       └── user.go*

评论

请输入您的评论. 可以使用维基语法:
 
教程/kratos/api定义.1751553170.txt.gz · 最后更改: tom