API References

Generate OpenRPC Reference

Fern enables you to generate professional, interactive API reference documentation for your JSON-RPC APIs using the OpenRPC specification. OpenRPC provides a standardized, machine-readable format for describing JSON-RPC 2.0 APIs, unlocking powerful documentation and code generation workflows.

Alchemy's OpenRPC API Reference Example
Example of Alchemy's docs site

How to Add an OpenRPC Endpoint

  1. Add your OpenRPC specification file (e.g., openrpc.yaml) to your /fern directory.
  2. Configure your generators.yml to point to your OpenRPC spec:
generators.yml
1api:
2  specs:
3    - openrpc: ../../api-specs/openrpc/wallet.yml

Configuration Properties

api.specs[].openrpc
Required

Path to your OpenRPC specification file. You can include multiple OpenRPC specs if your project exposes more than one JSON-RPC API.

Common Use Cases

JSON-RPC APIs are widely used for:

  • Blockchain & Crypto: Node RPC endpoints, wallet APIs
  • FinTech: Trading platforms, market data feeds
  • Developer Tools: Language servers, debuggers, automation
  • Distributed Systems: Remote procedure calls between services

Leverage Fern and OpenRPC to deliver world-class developer experiences for your JSON-RPC APIs.