获取 OpenAPI 契约

接口说明

读取描述 Developer OpenAPI 的机器可读 OpenAPI 契约。

接口信息

字段	值
方法	GET
路径	/openapi/v2/openapi.json
Operation ID	getDeveloperOpenApiContract
鉴权	Bearer OpenAPI key

入参

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

请求体

这个接口没有请求体。

请求示例

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

成功响应

200

返回 Developer OpenAPI 的完整 OpenAPI 3.1 契约。

字段	必填	类型	说明
openapi	是	string	本契约使用的 OpenAPI 规范版本。
info	是	object	产品信息、契约版本、许可证和用途。
servers	是	array<object>	本契约声明的服务基础地址。
security	是	array<object>	本契约声明的默认鉴权要求。
tags	是	array<object>	本契约包含的接口分组。
paths	是	object	本契约描述的 Developer OpenAPI 路径和操作。
components	是	object	可复用的数据结构和安全定义。

成功响应示例

{
  "openapi": "3.1.0",
  "info": {
    "title": "Focowiki Developer OpenAPI",
    "version": "0.7.47"
  },
  "servers": [
    {
      "url": "https://openapi.example.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Knowledge Bases"
    }
  ],
  "paths": {
    "/openapi/v2/knowledge-bases": {
      "get": {
        "operationId": "listKnowledgeBases",
        "summary": "List knowledge bases"
      },
      "post": {
        "operationId": "createKnowledgeBase",
        "summary": "Create a knowledge base"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {}
  }
}

错误码

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

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

后续操作

• 列出知识库