Skip to content

API 版本 ​

接口说明 ​

读取产品版本和 Developer OpenAPI 版本,便于客户端做兼容性判断。

接口信息 ​

字段值
方法GET
路径/openapi/v2/version
Operation IDgetDeveloperOpenApiVersion
鉴权Bearer OpenAPI key

入参 ​

这个接口没有路径参数或查询参数。

请求体 ​

这个接口没有请求体。

请求示例 ​

bash
curl -X GET "https://openapi.example.com/openapi/v2/version" \
  -H "Authorization: Bearer <openapi-key>"

成功响应 ​

200 ​

返回当前产品版本和 Developer OpenAPI 版本。

字段必填类型说明
product是"focowiki"产品标识。
version是string当前产品版本。
apiVersion是"v2"Developer OpenAPI 版本。

成功响应示例 ​

json
{
  "product": "focowiki",
  "version": "0.7.47",
  "apiVersion": "v2"
}

错误码 ​

下表列出这个接口已声明的全部错误响应。

HTTP 状态错误码说明
401UNAUTHORIZEDBearer API key 缺失、格式错误、未知、已撤销或已删除。
429RATE_LIMITED请求超过当前配置的速率限制。
500INTERNAL_ERRORAPI 遇到内部错误。
503DATABASE_REPOSITORY_UNAVAILABLE当前接口所需的数据暂时不可用。

后续操作 ​