Pojďme se společně podívat na to, jak napsat API dokumentaci tak, aby byla srozumitelná jak lidem, tak strojům. Jak ji udělat udržitelnou, verzovanou a snadno dostupnou.
Psaní dokumentace pro API je důležité, protože umožňuje vývojářům a dalším lidem, kteří s API pracují, snadné porozumění tomu, jak API funguje a jak se s ním pracuje. Zároveň je tato činnost často provázená značnou „bolestí”. Tato „bolest” pramení zejména z toho, že dokumentaci je potřeba udržovat, verzovat, doplňovat, upravovat nebo aktualizovat.