What is an API reference?
An API reference is the part of technical documentation that describes, one by one, what a software interface offers: each endpoint or function, the parameters it accepts, the data it returns, the possible errors and an example of a request. Unlike a tutorial, it is meant to be looked up, not read from start to finish.
How it works
A reference is usually generated from the code or from a specification file and published as a web page. Each entry follows the same pattern, so readers can scan quickly: name, short purpose, parameters with types, response, errors and a sample. For people who work offline, sign an agreement that needs an attachment, or simply prefer paper-style reading, the pages can be saved as a PDF. A good export keeps headings in order, code blocks readable and a clickable outline so that the reader can jump to an endpoint.
Why it matters
Developers lose time when they cannot find the exact name of a field or the meaning of an error code. A stable PDF copy of the reference for one version of the interface lets a partner, an auditor or a new colleague work from the same text, even without access to your site. It also records what the interface looked like at a given release, which helps when someone asks why an old integration behaves differently.
Using AuraDoc for it
HTML to PDF turns a saved web page of the reference into a PDF. Markdown to PDF does the same for reference pages written in Markdown. Add bookmarks to PDF builds an outline, for example one entry per endpoint group, so the reader can jump straight to it. Each tool saves a new file and leaves your originals as they were. AuraDoc does not generate the reference from your code or test your interface.
Tools that use this
Guides that put it into practice
- Turn a saved web page into a PDFStep by step: convert an HTML file into a PDF, add page numbers so it can be quoted, and compress it so it is easy to send or store.
- Turn a project README into a PDFStep by step: convert a README.md file into a formatted PDF with headings, lists, tables and code blocks, combine it with other project documents and number the pages for a handover.
- Rebuild the bookmarks of a PDFStep by step: check whether a PDF already has bookmarks, clear the old list and type a new one, so the bookmarks panel matches the document again.
Common questions
- Is an API reference the same as a tutorial?
- No. A tutorial guides a newcomer through a task, while a reference is a complete list to look things up in. Most projects need both.
- Can I export a reference as a PDF?
- Yes. Save the page or the Markdown source and convert it to PDF. Check that code blocks and tables are still readable afterwards.
- How do I keep a PDF reference current?
- Export a new file for each release and put the version in the name, so that readers always know which version they are reading.