OpenAPI 描述

spec/openapi.yaml 是 OpenAPI 3.0.3 描述，覆盖原生整段评测，声通兼容整段评测，语音合成与报告查询四个 REST 接口，持续集成每次构建都校验格式。实时评测的 WebSocket 协议无法用 OpenAPI 3.0 描述，见原生实时评测。

下载#

生成客户端#

npx @openapitools/openapi-generator-cli generate \
  -i https://open.shengzhiai.com/sdk/v2/spec/openapi.yaml \
  -g python -o yugu-client

-g 换成 go，php，csharp，rust 等生成器名即可得到对应语言的客户端。生成的客户端不含签名逻辑，要在请求拦截器里补上 X-App-Key，X-Timestamp，X-Nonce，X-Signature 四个请求头，被签名参数与拼接规则见签名与鉴权，各语言的签名函数见签名示例。生成的客户端发送 config 段时若带文件名，被签名参数改为去掉 config 后的表单参数加上 config JSON 的顶层非空标量字段。

描述内容#