For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
      • 预览更改
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • 生成 OpenRPC 参考
        • 生成 gRPC API 参考
        • 生成 GraphQL 参考
        • Library Reference
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
预约演示登录免费开始
在本页
  • 配置
  • 包含多个 OpenRPC 参考文档
  • 配置属性
预览与发布Generation

生成 OpenRPC 参考文档

||以 Markdown 格式查看|
此页面是否有帮助？
在仪表板中编辑
上一个

生成 WebSocket 参考

下一个

生成 gRPC API 参考文档

Fern 从 OpenRPC 规范生成 OpenRPC 参考文档。

Alchemy's OpenRPC API Reference Example
Alchemy 文档站点示例

配置

1

设置项目结构

将您的 OpenRPC 规范文件（例如 openrpc.yaml）添加到 /fern 目录中，并创建一个引用它的 generators.yml：

generators.yml
1api:
2  specs:
3    - openrpc: ./openrpc.yml
2

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

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

docs.yml
1navigation:
2  - api: API Reference
3

自定义布局

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

包含多个 OpenRPC 参考文档

要在文档中包含多个 OpenRPC 定义，请使用 api-name 属性。api-name 对应包含您的 OpenRPC 定义的文件夹名称。

fern
fern.config.json
docs.yml
wallet-api
openrpc.yml# Wallet OpenRPC spec
generators.yml
nft-api
openrpc.yml# NFT OpenRPC spec
generators.yml
docs.yml
1navigation:
2  - api: Wallet API
3    api-name: wallet-api
4  - api: NFT API
5    api-name: nft-api

配置属性

api.specs[].openrpc
Required

您的 OpenRPC 规范文件的路径。如果您的项目公开多个 JSON-RPC API，您可以包含多个 OpenRPC 规范。