应用发布
功能概述
应用发布(Release)功能允许你将项目中的多个文档部署聚合为一个统一的 API 应用,并通过稳定的 URL 别名和版本管理对外提供服务。与单个 Deployment 不同,Release 提供了应用级别的端点管理、分组、鉴权配置和版本快照能力。
核心价值:
| 能力 | 说明 |
|---|---|
| 端点聚合 | 将多个 Deployment 组合成一个完整的 API 应用 |
| 稳定 URL | 通过别名(alias)提供不变的访问地址 |
| 版本管理 | 每次发布生成版本快照,支持回溯 |
| 鉴权控制 | 统一配置 API 访问权限 |
| 动态 API 文档 | 发布时固化 REST/OpenAPI 文档与版本 Changelog |
界面说明
Release 管理页面位于项目编辑器内,采用侧边栏 + 主区域的双栏布局。
侧边栏
侧边栏展示当前 Release 的所有 API 端点列表,支持两种分组模式:
- 路径前缀分组:按端点路径的第一级自动聚合(如
/users/...、/orders/...) - 标签分组:按自定义 Group 标签聚合
每个端点项显示 HTTP 方法(GET/POST/PUT/DELETE/PATCH)和路径,不同方法以不同颜色区分。点击端点进入端点配置页面。右键端点可重命名或删除。
顶部提供新建端点和设置按钮。
主区域
主区域通过 Tab 导航切换不同视图:
| Tab | 内容 |
|---|---|
| Overview | Release 基础信息(名称、别名、描述、图标)和空状态引导 |
| Endpoints | 端点列表管理 |
| Config | 全局配置(鉴权等) |
| Groups | 端点分组管理 |
选中具体端点时,主区域切换为端点配置页面,显示面包屑导航。
顶部操作栏
- 保存状态指示:实时显示保存状态(未修改 / 未保存 / 保存中 / 已保存 / 保存失败)
- Preview 按钮:预览即将发布的变更(新增、删除、修改的端点)
- Publish 按钮:确认发布,创建新版本并立即上线
操作步骤
创建 Release
- 进入项目编辑器,在左侧菜单中选择「Release」
- 首次进入会显示空状态引导页面
- 填写 Release 名称和别名(别名用于生成稳定的访问 URL)
- 系统自动保存配置
添加端点
- 点击侧边栏顶部的「+」按钮创建新端点
- 在端点配置页面中设置:
- 路径:API 路径(如
/users/list) - HTTP 方法:GET、POST、PUT、DELETE、PATCH
- 绑定的 Deployment:选择项目中已有的文档部署
- 输入/输出定义
- 路径:API 路径(如
- 修改会自动保存
管理端点分组
- 切换到「Groups」Tab
- 创建分组并为端点分配标签
- 侧边栏可切换为「标签分组」模式查看
预览与发布
- 点击顶部「Preview」按钮,查看当前版本与上次发布的差异
- 确认无误后点击「Publish」按钮
- 可填写本版本的公开发布说明,然后点击发布
- 系统创建运行版本,并同时固化一份只包含对外契约的 API 文档快照
- 发布成功后显示版本号(如
v1.0.0)
配置 API 文档可见性
在「Config」中选择 API 文档可见性:
- 私有:默认值。发布时仍生成文档快照;匿名访问返回 404,登录文档站后按当前项目读取权限查看。
- 不公开列出:知道链接的用户可以访问,不出现在“已发布 API”目录。
- 公开:可以访问,并显示在文档站的“已发布 API”频道。
登录后的“已发布 API”目录会同时展示全部公开 API,以及你有权读取项目中的私有/不公开列出 API。项目所有者、Team Owner、已接受邀请的团队成员和获得项目 read 授权的同事均可查看;站点管理员身份本身不会绕过项目权限。
可见性修改会在下一次成功发布时生效。在重新发布之前,现有文档继续保持上一次发布时的状态。
发布后可通过 Release 顶部的「API 文档」进入动态文档页,私有文档会先要求登录。每个版本包含端点、鉴权、请求/响应字段、OpenAPI JSON、发布说明和对外契约变更记录。
非官方 API 边界
普通团队发布的页面会固定显示“非 WaiNao 官方 API”提示及免责声明。只有由站点管理员维护的可信团队名单可以使用 WaiNao 官方标识;发布者不能自行声明官方身份。
动态文档只使用开发人员配置后的外部 REST 契约,不展示工作流正文、Block、Prompt、内部变量、Deployment 绑定、字段映射或 API Key 标识。