暴露操作
规范中并非每个操作都应公开。管理接口、内部工具和草稿操作往往需要保留在文档中,但对已发布文档和 MCP 隐藏。暴露配置让这一选择明确,且不修改源文档。
工作方式
暴露配置与规范分开存储。每条记录引用一个操作并记录它是否启用:
- 存在时优先使用操作的
operationId; - 同时存储
method和path,用于没有操作 ID 的规范以及校验。
原始文档保持不动。文档和 MCP 由规范结合已启用操作生成,因此禁用某个操作会把它从已发布面移除,而不从你的文件中删除。
暴露工作区
暴露操作形态为处理大型规范而构建:
- 搜索——按方法、路径、摘要或标签过滤操作;
- 按标签分组——操作按其主要标签分组,未打标签的操作归入未分组;
- 单独切换——开启或关闭单个操作;
- 按组批量——一次启用或禁用某个标签组中的所有操作;
- 全选(已过滤)——全局复选框应用于当前匹配搜索的操作。
每个操作一行,即使操作带有多个标签,启用状态也保持明确。
实用默认
一个简单直接的做法是从全部启用开始,再禁用你不想公开的操作:
- 内部和管理接口(例如用户管理或内部健康检查);
- 仍在设计中的操作;
- 仅用于本地调试的接口。
由于选择独立于文档,你可以随 API 演进而更改它,无需编辑规范本身。
暴露与发布如何相互作用
暴露决定出现哪些操作;其他控件决定文档是否根本可达:
- 文档必须为
ACTIVE; - 文档和 MCP 各有启用标记;
- 访问可由查看密码(文档)或访问密钥(MCP)把关。
完整把关项参见访问控制。
计划额度
各计划限制暴露操作数量:
- Free(免费)——最多 10 个;
- Pro——最多 1,000 个;
- Team——最多 10,000 个。