开源项目 `api-server` 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00765/article/details/142162242

开源项目 `api-server` 使用教程

api-server 武汉新型冠状病毒防疫信息收集平台后端代理 api-server of Wuhan2020 项目地址: https://gitcode.com/gh_mirrors/api/api-server

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

api-server/
├── artifacts/
│   └── example/
│       └── apiservice.yaml
├── hack/
├── main.go
└── pkg/
    ├── admission/
    ├── apis/
    ├── apiserver/
    ├── cmd/
    ├── generated/
    │   ├── clientset/
    │   │   └── versioned/
    │   │       └── typed/
    │   │           └── wardle/
    │   │               ├── v1alpha1/
    │   │               └── v1beta1/
    │   ├── informers/
    │   │   └── externalversions/
    │   │       └── wardle/
    │   │           ├── v1alpha1/
    │   │           └── v1beta1/
    │   ├── listers/
    │   │   └── wardle/
    │   │       ├── v1alpha1/
    │   │       └── v1beta1/
    └── registry/

目录结构介绍

artifacts/: 用于存放部署的 YAML 示例文件，例如 apiservice.yaml。
hack/: 存放自动脚本，例如 update-codegen 等。
main.go: 项目的启动入口文件。
pkg/: 包含项目的核心代码。
- admission/: 与准入控制相关的代码。
- apis/: 定义 API 资源和版本。
- apiserver/: 实现 API 服务器的核心逻辑。
- cmd/: 命令行工具的入口。
- generated/: 自动生成的客户端、列表器和信息器代码。
  - clientset/: 生成的客户端代码。
  - informers/: 生成的信息器代码。
  - listers/: 生成的列表器代码。
- registry/: 注册 API 资源的地方。

2. 项目的启动文件介绍

`main.go`

main.go 是项目的启动入口文件。它负责初始化并启动 API 服务器。以下是 main.go 的主要功能：

初始化配置: 加载配置文件并初始化 API 服务器的配置。
启动 API 服务器: 启动 API 服务器，监听指定的端口并处理客户端请求。

package main

import (
    "log"
    "os"
    "github.com/wuhan2020/api-server/pkg/cmd"
)

func main() {
    if err := cmd.RunServer(); err != nil {
        log.Fatalf("Error running server: %v", err)
        os.Exit(1)
    }
}

3. 项目的配置文件介绍

`apiservice.yaml`

apiservice.yaml 是一个示例配置文件，用于定义 API 服务的配置。以下是该文件的主要内容：

apiVersion: apiregistration.k8s.io/v1
kind: APIService
metadata:
  name: v1.duyanghao.example.com
spec:
  group: duyanghao.example.com
  groupPriorityMinimum: 1000
  version: v1
  versionPriority: 100
status:
  conditions:
    - lastTransitionTime: "2020-12-11T08:45:37Z"
      message: Local APIServices are always available
      reason: Local
      status: "True"
      type: Available

配置文件介绍

apiVersion: 定义 API 服务的版本。
kind: 定义资源的类型为 APIService。
metadata: 定义 API 服务的元数据，包括名称。
spec: 定义 API 服务的详细配置。
- group: API 服务的组名。
- groupPriorityMinimum: 组的优先级。
- version: API 服务的版本。
- versionPriority: 版本的优先级。
status: 定义 API 服务的状态。
- conditions: 状态的条件，包括上次转换时间、消息、原因和状态类型。