开发 k8s 管理平台 - k8sailor 04. 使用 gin 创建第一个 API 接口

简介: 开发 k8s 管理平台 - k8sailor 04. 使用 gin 创建第一个 API 接口

开发 k8s 管理平台 - k8sailor 04. 使用 gin 创建第一个 API 接口

原文地址: https://tangx.in/posts/books/k8sailor/chapter01/04-init-httpserver/
tag: https://github.com/tangx/k8sailor/tree/feat/04-httpserver-initial
cd cmd/k8sailor && go run . httpserver

启动 web 服务器

Usage:
  k8sailor httpserver [flags]

Flags:
  -h, --help   help for httpserver

Global Flags:
      --config string   k8s 配置授权文件 (default "./k8sconfig/config.yml")

2021/09/24 07:56:51 open config/local.yml: no such file or directory
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /k8sailor/v0/ping         --> github.com/tangx/k8sailor/cmd/k8sailor/apis.RootGroup.func1 (3 handlers)
[GIN-debug] Listening and serving HTTP on :8088

创建 pkg/confgin 初始化配置文件

为了方便服务配置管理, 将使用 使用 jarvis 初始化配置

需要对 httpserver 进行一些初始化配置

// Server 定义一个 gin httpserver 的关键字段
// `env:""` 可以通过 `github.com/go-jarvis/jarvis` 库渲染成配置文件
type Server struct {
    Host    string `env:""`
    Port    int    `env:""`
    Appname string `env:""`
    engine  *gin.Engine
}

其中需要额外强调的是, httpserver 必须 有自己的 应用名 的前缀路由。 应该 有自己的版本路由。

http://127.0.0.1:8088/appname/v0/ping

在服务容器化后, 具有自己 应用名 路由的服务对 各家 ingress 规则都是友好的。 如果没有, 上线之后要强行使用 rewrite 实现的话, 那就必须依赖 ingress controller 的实现了。

如果 rewrite 规则里面 正则表达式 , 那就让运维哭去吧

目前所知

  • nginx ingress controller 支持 rewrite, 支持正则表达式
  • traefik 好像可以使用 middleware 实现, 不支持正则表达式
  • istio 有自己的规则, 但不支持正则表达式
// RegisterRoute 注册
func (s *Server) RegisterRoute(registerFunc func(rg *gin.RouterGroup)) {

    // 注册以服务名为根的路由信息,方便在 k8s ingress 中做转发
    base := s.engine.Group(s.Appname)

    // 注册业务子路由
    registerFunc(base)
}

使用 jarvis 初始化配置

jarvis 是一个对 配置解析配置加载 操作封装的库。

  1. 可以方便的通过 config struct 解析出对应的配置参数。
  2. 在启动时, 支持通过 配置文件环境变量 加载配置参数, 对 k8s 容器应用还算友好。
  3. 支持 giltab 分支配置特点, 可以在不同分支使用不同的变量值。

具体使用案例, 可以参考 github 的 demo github.com/go-jarvis/jarvis

// 定义服务相关信息
var (
    HttpServer = &confgin.Server{}

    app = jarvis.App{
        Name: "k8sailor",
    }
)

// 使用 jarvis 初始化配置文件
func init() {
    config := &struct {
        HttpServer *confgin.Server
    }{
        HttpServer: HttpServer,
    }
    app.Conf(config)
}

在运行的时候, 会在 运行 根目录生成 config/default.yml 文件。 该文件不要直接修改, 每次运行将被覆盖。

加载顺序 default.yml -> config.yml -> local.yml / config.branch.yml -> env

如果本地开发, 可以把一些关键的敏感配置放在 local.yml 中并 .gitignore 忽略。

为命令行添加 httpserver 子命令

初始化子命令

并设置启动命令

// runHttpserver 启动 http server
func runHttpserver() {
    // 1. 将 apis 注册到 httpserver 中
    global.HttpServer.RegisterRoute(apis.RootGroup)

    // 2. 启动服务
    if err := global.HttpServer.Run(); err != nil {
        logrus.Fatalf("start httpserver failed: %v", err)
    }
}

完成之后, 在 cmd/root.go 命令中添加子命令

func init() {
    cobrautils.BindFlags(rootCmd, global.Flags)

    // 添加子命令
    rootCmd.AddCommand(cmdHttpserver)
}

创建并注册路由

自定义启动参数

由于是用了 jarvis 库, 在程序启动的时候, 会在运行目录生成 config/defualt.yml 配置文件。

复制并重命名为 config.yml 覆盖默认值。

k8sailor__HttpServer_Appname: k8sailor
k8sailor__HttpServer_Host: ""
k8sailor__HttpServer_Port: 8088

启动

如开头所示, 可以看到, 配置项已成功被应用

  • httpserver 的根路由为 /k8sailor/v0/xxxxx
  • httpserver 的监听端口为 8088

如果要在容器中运行, 只需要在容器中注入相同变量名的变量

export k8sailor__HttpServer_Appname=k8sailor
相关实践学习
通过Ingress进行灰度发布
本场景您将运行一个简单的应用,部署一个新的应用用于新的发布,并通过Ingress能力实现灰度发布。
容器应用与集群管理
欢迎来到《容器应用与集群管理》课程,本课程是“云原生容器Clouder认证“系列中的第二阶段。课程将向您介绍与容器集群相关的概念和技术,这些概念和技术可以帮助您了解阿里云容器服务ACK/ACK Serverless的使用。同时,本课程也会向您介绍可以采取的工具、方法和可操作步骤,以帮助您了解如何基于容器服务ACK Serverless构建和管理企业级应用。 学习完本课程后,您将能够: 掌握容器集群、容器编排的基本概念 掌握Kubernetes的基础概念及核心思想 掌握阿里云容器服务ACK/ACK Serverless概念及使用方法 基于容器服务ACK Serverless搭建和管理企业级网站应用
相关文章
|
8天前
|
API 数据安全/隐私保护 UED
探索鸿蒙的蓝牙A2DP与访问API:从学习到实现的开发之旅
在掌握了鸿蒙系统的开发基础后,我挑战了蓝牙功能的开发。通过Bluetooth A2DP和Access API,实现了蓝牙音频流传输、设备连接和权限管理。具体步骤包括:理解API作用、配置环境与权限、扫描并连接设备、实现音频流控制及动态切换设备。最终,我构建了一个简单的蓝牙音频播放器,具备设备扫描、连接、音频播放与停止、切换输出设备等功能。这次开发让我对蓝牙技术有了更深的理解,也为未来的复杂项目打下了坚实的基础。
95 58
探索鸿蒙的蓝牙A2DP与访问API:从学习到实现的开发之旅
|
6天前
|
存储 API 计算机视觉
自学记录HarmonyOS Next Image API 13:图像处理与传输的开发实践
在完成数字版权管理(DRM)项目后,我决定挑战HarmonyOS Next的图像处理功能,学习Image API和SendableImage API。这两个API支持图像加载、编辑、存储及跨设备发送共享。我计划开发一个简单的图像编辑与发送工具,实现图像裁剪、缩放及跨设备共享功能。通过研究,我深刻体会到HarmonyOS的强大设计,未来这些功能可应用于照片编辑、媒体共享等场景。如果你对图像处理感兴趣,不妨一起探索更多高级特性,共同进步。
61 11
|
20天前
|
人工智能 自然语言处理 API
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口,能够处理文本、音频和视频输入,提供自然流畅的对话体验,适用于多种应用场景。
67 3
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
|
3天前
|
JSON API 开发者
Lazada 商品评论列表 API 接口:开发、应用与收益
Lazada作为东南亚领先的电商平台,其商品评论数据蕴含丰富信息。通过开发和利用Lazada商品评论列表API接口,企业可深入挖掘这些数据,优化产品、营销和服务,提升客户体验和市场竞争力。该API基于HTTP协议,支持GET、POST等方法,开发者需注册获取API密钥,并选择合适的编程语言(如Python)进行开发。应用场景包括竞品分析、客户反馈处理及精准营销,帮助企业提升销售业绩、降低运营成本并增强品牌声誉。
18 2
|
7天前
|
供应链 搜索推荐 API
1688榜单商品详细信息API接口的开发、应用与收益
1688作为全球知名的B2B电商平台,为企业提供丰富的商品信息和交易机会。为满足企业对数据的需求,1688开发了榜单商品详细信息API接口,帮助企业批量获取商品详情,应用于信息采集、校验、同步与数据分析等领域,提升运营效率、优化库存管理、精准推荐、制定市场策略、降低采购成本并提高客户满意度。该接口通过HTTP请求调用,支持多种应用场景,助力企业在电商领域实现可持续发展。
46 4
|
7天前
|
JSON 安全 API
淘宝商品详情API接口(item get pro接口概述)
淘宝商品详情API接口旨在帮助开发者获取淘宝商品的详细信息,包括商品标题、描述、价格、库存、销量、评价等。这些信息对于电商企业而言具有极高的价值,可用于商品信息展示、市场分析、价格比较等多种应用场景。
|
6天前
|
监控 搜索推荐 API
京东按图搜索京东商品(拍立淘)API接口的开发、应用与收益
京东通过开放商品详情API接口,尤其是按图搜索(拍立淘)API,为开发者、企业和商家提供了创新空间和数据支持。该API基于图像识别技术,允许用户上传图片搜索相似商品,提升购物体验和平台竞争力。开发流程包括注册账号、获取密钥、准备图片、调用API并解析结果。应用场景涵盖电商平台优化、竞品分析、个性化推荐等,为企业带来显著收益,如增加销售额、提高利润空间和优化用户体验。未来,随着数字化转型的深入,该API的应用前景将更加广阔。
44 1
|
14天前
|
监控 供应链 搜索推荐
阿里妈妈商品详情API接口:开发、应用与收益的深度剖析
阿里妈妈是阿里巴巴旗下的数字营销平台,其商品详情API接口为开发者提供了获取淘宝、天猫等电商平台商品详细信息的工具。本文介绍了该接口的开发流程、应用场景及带来的收益,揭示了其在电商生态中的重要地位。
76 6
|
14天前
|
供应链 搜索推荐 API
1688APP原数据API接口的开发、应用与收益(一篇文章全明白)
1688作为全球知名的B2B电商平台,通过开放的原数据API接口,为开发者提供了丰富的数据资源,涵盖商品信息、交易数据、店铺信息、物流信息和用户信息等。本文将深入探讨1688 APP原数据API接口的开发、应用及其带来的商业收益,包括提升流量、优化库存管理、增强用户体验等方面。
74 6
|
15天前
|
前端开发 API 数据库
Next 编写接口api
Next 编写接口api