docs: prepare v0.1.0 remote SDK integration release

This commit is contained in:
2026-09-20 23:04:23 +08:00
parent 662dc8d0d1
commit 0e8b2ef297
5 changed files with 49 additions and 21 deletions

View File

@@ -144,17 +144,30 @@ Options.HTTPClient 可注入专用 HTTP 客户端。SDK 复制配置,不修改
健康响应最多 16 KiB,业务响应最多 1 MiB,请求最多 512 KiB。大业务内容应传对象引用。参数/result 使用 json.RawMessage,不转成 float64;revision 在 Go 中为 uint64,JSON 编码为字符串。服务端字段及上限见各接口手册。
## 5. 外部项目本地接入
## 5. 外部项目通过远端接入
SDK 尚未发布版本。开发期可以用本地 replace:
业务项目需要 Go 1.27.1 或更高版本。在业务项目的 `go.mod` 所在目录安装首个接入版本:
```sh
go mod edit -require=git.yuntuo.hk/k2safe/orbit/sdk/go@v0.0.0
go mod edit -replace=git.yuntuo.hk/k2safe/orbit/sdk/go=/absolute/path/to/orbit/sdk/go
go mod tidy
go get git.yuntuo.hk/k2safe/orbit/sdk/go@v0.1.0
```
将示例路径换成真实路径,不要把本机绝对路径作为发布依赖提交。后续会验证独立 module 标签和真实远端取包,再提供 go get 发布命令。当前源码同时验证 GOWORK=off 的独立构建。
代码中导入:
```go
import orbit "git.yuntuo.hk/k2safe/orbit/sdk/go"
```
添加实际调用后,执行:
```sh
go mod tidy
go mod verify
```
SDK 位于仓库子目录,对应 Git 标签为 `sdk/go/v0.1.0`;`go get` 使用模块版本 `v0.1.0`。服务端对应仓库标签为 `v0.1.0`。业务项目固定版本并提交 `go.mod` 与 `go.sum`,无需本地源码、`replace` 或 Orbit 的 `go.work`。如果此前配置过本地替换,先执行 `go mod edit -dropreplace=git.yuntuo.hk/k2safe/orbit/sdk/go`。
这是开发与测试接入版本;生产部署仍按[交付清单](../release-checklist.md)完成目标环境验收。版本发布和校验规则见[发布说明](release.md)。
## 6. 查询执行历史与证据