Reonomy Technical Documentation - Event Recap

API The Docs Virtual 2021 Showcase Your Devportal

This demo was presented at API The Docs Virtual 2021 Showcase Your Devportal event series on 13 October. We are glad to present the video recording of the event with the demo and the Q&A session. Enjoy!

Visit the Showcase Your DevPortal Recap page for summaries and recordings.



In the demo, you can hear about:

  • Reonomy’s Property API documentation that contains handwritten and auto-generated sections
  • How D3 can be used to render nested response and request schemas
  • A Query Builder, an interactive editor that let users compose API requests
  • Predefined API request examples that users can edit
  • Pages to help novice users to get started
  • How schema visualizations can help business users exploring data

Reonomy Technical Documentation


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.


Q&A

  • 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?

Sign up to our Developer Portal Newsletter so that you never miss out on the latest API The Docs recaps and our devportal, API documentation and Developer Experience research publications.