| title | 在线文档 |
|---|---|
| icon | doc |
在线文档将 Fast Request 中已保存的 API 汇总为可浏览、可维护的文档工作区。请求参数、Schema、响应示例等内容都来自保存后的请求数据，适合本地查看或通过局域网分享给团队。
在 Request 窗口工具栏中点击 在线文档，即可打开当前项目的文档工作区。左侧按分组展示已同步的 API，支持搜索；右侧可以查看和编辑 API 的基本信息、请求参数、请求体、响应示例及 Schema。
::: tip 必填字段批量操作 在 Schema 中选中多行后，按 Space 可以批量设置或取消必填。 :::
点击 在线文档设置，可以启用 保存请求后自动同步在线文档。启用后，单个保存请求和批量生成 API都会将最终保存结果同步到在线文档。
文档已存在时支持两种策略：
- 覆盖已有文档：使用当前请求重新生成文档快照。AI 优化后的参数示例也会写入文档。
- 保留已有文档，跳过更新：保留已经人工编辑的文档内容。
在文档工作区启动服务后，可以通过浏览器打开在线文档：
- 使用本机地址进行本地预览。
- 使用局域网地址分享给同一网络内的团队成员。
- 可使用自动端口，也可以指定固定端口。
- 在 Request 中生成并确认 API 参数。
- 如有需要，使用 AI 参数智能优化生成更真实的示例值。
- 保存请求，或对类、包执行批量生成并保存。
- 打开在线文档检查结果，再启动服务进行分享。
::: warning 选择“覆盖已有文档”时，在线文档中手工编辑的对应内容会被最新请求快照替换。如果需要长期保留人工修改，请选择“跳过更新”。 :::