读取 OpenAPI 接口契约

调用说明 #

需要 addon.view 或 api_doc.view。此接口直接返回 OpenAPI 文档，不包装 code/message/data。请直接访问或使用未安装业务响应拦截器的 Axios 实例。

公开阅读和下载同一份契约可以使用 /docs/openapi.json，不包含运行时账号、角色数据或任何密钥。

Axios 请求示例 #

在已登录后台页面中调用；示例角色 ID 仅用于说明，请替换为当前系统中的实际角色。

axios.create().get('/api/v1/openapi');

响应结构示例 #

以下为结构示例，不是实时接口结果；列表和文档对象可能省略部分项目。

{
    "openapi": "3.1.0",
    "info": {
        "title": "SaleSass 应用开发者接口",
        "version": "1.0.0"
    },
    "servers": [
        {
            "url": "/api/v1"
        }
    ]
}

响应状态 #