把 API 网关接进 CI:契约测试的价值
网关升级、改协议适配逻辑之后,最怕的是「某个客户端悄悄不能用了」。契约测试能把这类风险从线上转移到流水线里。
最小契约集:每个协议一条
三条协议路径各准备一个最小请求,断言状态码、响应结构、关键字段存在。这些测试跑得快,适合放进每次 PR。
最小请求的价值在于排除干扰:先用最短的 prompt、关闭流式、不带任何工具,把链路跑通。
工具调用的契约要单独覆盖
工具相关的行为变化最隐蔽——文本请求全绿,工具场景已经坏了。契约测试里必须有工具往返一例。
文本透传是最简单的路径,工具调用才是检验一个网关成色的地方。
所以做工具调用的第一天,不要急着接 Agent 框架,先用最朴素的 curl 把单轮工具调用跑通。
流式要断言事件序列
不只断言「有内容返回」,还要断言事件顺序、结束事件的类型,以及异常时是不是有明确的 error 事件。
很多自建转发在流式上做得糙:要么等上游整个响应回来再切片伪流式,要么把 SSE 帧原样透传但不做任何错误处理。
真正的流式代理要处理三件事:帧的边界、上游的中途报错、以及客户端中途断开时的取消传播。
错误码也是契约的一部分
模型不存在、额度不足、Key 无效——每个错误码都该有对应的断言。改了错误码就是破坏契约。
网关返回的错误体里,code 字段比 message 更值得被日志记录。
message 是给人看的,可能会变;code 是稳定的契约,可以拿来做监控告警和自动重试判断。
实操:单轮工具调用的最小闭环,先跑通再加 Agent 框架。
这段工具循环可以直接改造成一条契约测试用例。
import json, os
from openai import OpenAI
client = OpenAI(api_key=os.environ["GATEWAY_API_KEY"],
base_url="https://aiminis.info/v1")
TOOLS = [{
"type": "function",
"function": {
"name": "get_weather",
"description": "查询指定城市的天气",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"],
},
},
}]
messages = [{"role": "user", "content": "杭州今天天气怎么样?"}]
resp = client.chat.completions.create(
model="gpt-6-sol", messages=messages, tools=TOOLS,
)
msg = resp.choices[0].message
if msg.tool_calls:
for call in msg.tool_calls:
args = json.loads(call.function.arguments)
result = my_weather_func(args["city"]) # 你的业务逻辑
messages.append(msg) # 模型发出的调用
messages.append({
"role": "tool",
"tool_call_id": call.id,
"content": json.dumps(result, ensure_ascii=False),
})
final = client.chat.completions.create(
model="gpt-6-sol", messages=messages, tools=TOOLS,
)
print(final.choices[0].message.content)
几个容易踩的坑
- 把 API Key 硬编码在代码里然后提交到仓库。
- 每次失败都重试,包括参数错误、额度不足这类永远不会成功的错误。
- 没有对已经产生上游用量的请求做重放保护,账单翻倍。
- 模型 ID 从旧文档里抄,实际 Key 没有该模型权限。
小结
网关这层看不见,但它的每一次选择都在影响你的延迟、成本和成功率,值得花点时间打磨。
文中的示例接口都可以在 https://aiminis.info/ 上直接验证,用量与额度在用户中心 https://aiminis.info/console 随时可查。
- 点赞
- 收藏
- 关注作者
评论(0)