Grapi 开源项目使用教程

Grapi 开源项目使用教程

grapi😮 A surprisingly easy API server and generator in gRPC and Go项目地址:https://gitcode.com/gh_mirrors/gr/grapi

1. 项目的目录结构及介绍

Grapi 项目的目录结构如下：

grapi/
├── cmd/
│   ├── server/
│   │   └── run.go
│   └── import-books/
│       └── run.go
├── pkg/
│   └── grapiserver/
│       └── server.go
├── api/
│   └── book/
│       ├── book.pb.go
│       ├── book.pb.gw.go
│       └── book.proto
├── Gopkg.toml
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含应用程序的入口点，如 server 和自定义命令 import-books。
• pkg/: 包含项目的核心包，如 grapiserver。
• api/: 包含 API 定义文件，如 .proto 文件及其生成的 .pb.go 和 .pb.gw.go 文件。
• Gopkg.toml: 使用 dep 进行依赖管理的配置文件。
• go.mod 和 go.sum: 使用 Go Modules 进行依赖管理的文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/server/run.go，其主要功能是启动 Grapi 服务器。

package main

import (
    "context"
    "github.com/izumin5210/grapi/pkg/grapiserver"
)

func Run() error {
    s := grapiserver.New(
        grapiserver.WithDefaultLogger(),
        grapiserver.WithServers(
            server.NewBookServiceServer(),
        ),
    )
    return s.Serve()
}

启动文件介绍

• Run(): 该函数初始化并启动 Grapi 服务器。
• grapiserver.New(): 创建一个新的 Grapi 服务器实例。
• grapiserver.WithDefaultLogger(): 启用默认日志记录器。
• grapiserver.WithServers(): 注册生成的服务到 Grapi 服务器实例。

3. 项目的配置文件介绍

Grapi 项目使用 Gopkg.toml 进行依赖管理，如果使用 Go Modules，则使用 go.mod 和 go.sum。

Gopkg.toml

[[constraint]]
name = "github.com/izumin5210/grapi"
version = "0.5.0"

go.mod

module github.com/izumin5210/grapi

go 1.11

require (
    github.com/golang/protobuf v1.3.2
    google.golang.org/grpc v1.26.0
)

配置文件介绍

• Gopkg.toml: 定义项目的依赖版本。
• go.mod: 定义模块路径和所需的依赖包及其版本。
• go.sum: 记录依赖包的哈希值，确保依赖的完整性和安全性。

以上是 Grapi 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 Grapi 项目。

grapi😮 A surprisingly easy API server and generator in gRPC and Go项目地址:https://gitcode.com/gh_mirrors/gr/grapi