In this week’s #dofixdifferently, Chris Lees outlines how to make your API documentation genuinely re-usable.
Efficient API documentation needs to be both human-readable and machine-readable, and in this episode Chris outlines approaching documentation in the right way, highlighting common pitfalls, and articulating how to go from where you are today over to a new, more re-usable (and automated) future.
Human-readable & machine-readable formats:
FIX Orchestra (XML, FIX Trading Community)
FinSpec (JSON, FixSpec)