生成 REST API 参考文档

设置项目结构

将您的规范文件添加到 /fern 目录中，并创建一个在 api.specs 部分引用它的 generators.yml：

1
api:
2
  specs:
3
    - openapi: "./openapi.yml"

将 API 参考文档添加到导航中

在 docs.yml 的导航中添加 - api: API Reference：

1
navigation:
2
  - api: API Reference

Fern 将自动从您的 API 定义中填充端点、类型和代码片段。请求和响应示例是使用 AI 生成的，显示真实数据而不是占位符值。

自定义布局

有关配置选项和布局自定义的完整列表，请参见 自定义 API 参考布局。