生成 OpenRPC 参考文档 | Fern Documentation

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

配置

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

generators.yml

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

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

docs.yml

1 navigation:
2   - api: API Reference

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

要在文档中包含多个 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

1 navigation:
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 规范。