Peter Henderson (Software Engineer and Technical Writer)
The Reonomy API reference is autogenerated from an OpenAPI spec combined with custom handwritten content. The site is built on page load after fetching the latest version of the spec, ensuring the site is always up-to-date without requiring a new CI/CD build every time the spec changes. The autogenerated code is displayed in any of three languages, ready to copy/paste. If you've entered a valid API token, you can run requests directly from the API reference's code component to see the response. Tooltip descriptions are available by clicking the attribute names within the response section.
Read more on Reonomy Technical Documentation's Devportal Awards nomination page.
- What is the writer experience like?
- What tools do you use for writing and maintaining documentation?
- Where can one find more information on D3 modeling?