API Reference Generator from Contract ABI

WHAT IT DOES

API Reference Generator from Contract ABI takes a contract's ABI JSON and transforms it into clean, human-readable API documentation. It parses the ABI and extracts all functions, events, errors, constructors, and fallback/receive functions, then presents them in a structured, easy-to-scan format. For each function, it shows the name, full signature with parameter types and names, return types, mutability (view/pure/payable/nonpayable), and a read/write tag. For events, it displays the parameters and highlights which are indexed. For errors, it shows the error signature. The tool also displays a summary of the contract and generates a Markdown version you can copy for your project documentation. This is invaluable for developers documenting smart contracts, creating SDKs, writing developer guides, or generating API references for internal teams.

HOW TO USE

Connect your wallet to select the network (optional—the tool works without a connection). Enter an optional contract name. Paste your contract ABI as a JSON array into the textarea. Click "Generate API Reference." The tool parses the ABI and displays a categorized reference with all functions, events, errors, and constructors. Each entry shows the signature, parameters, return types, and relevant tags. You can copy the entire reference as Markdown using the "Copy API Reference (Markdown)" button, which formats the documentation for use in GitHub, README files, or project wikis. The tool handles all standard ABI entries and presents them in a consistent, professional format.

THE REAL MECHANISM

The tool uses a pure JavaScript parser that operates entirely client-side. It takes the ABI JSON array and iterates through each entry, filtering by type: function, event, constructor, error, fallback, and receive. For each entry, it extracts the relevant fields—name, inputs, outputs, stateMutability, and anonymous/indexed flags—and formats them into a readable string. Parameters and return types are displayed with their Solidity types and parameter names. The tool also categorizes functions as "read" (view/pure) or "write" (nonpayable/payable) for quick scanning. The Markdown export generates a structured document with headings and lists that can be copied directly into project documentation. No external libraries or API calls are required—all processing is done in the browser.

WHAT IT CANNOT SEE

This tool cannot recover function names from bytecode—it requires a complete ABI. It cannot generate usage examples or test cases for the functions. It cannot detect if the ABI matches the actual deployed contract—you must verify that yourself. It cannot generate API documentation for non-EVM contracts or for contracts that do not provide an ABI. It cannot produce interactive API endpoints or generate server-side code (e.g., REST or GraphQL). It cannot translate between Solidity types and other programming languages automatically. It cannot detect missing or malformed ABI entries—it will display what is present and ignore invalid entries. The tool does not fetch the ABI from the chain—you must paste it manually.

PLEASE NOTE

API Reference Generator works for any EVM-compatible contract ABI and does not require a blockchain connection to function, though the network selector is provided for context. It is a documentation tool for developers, not an on-chain analysis tool. It reads data only and does not send any information to external servers. The tool is free to use and does not require authentication. For best results, use the complete ABI exported from your compilation artifact (e.g., from Hardhat, Foundry, or Truffle).