API (или интерфейс прикладного программирования) — это набор правил (функций, переменных, классов, протоколов и т.д.), которые определенные системы (приложения, библиотеки) используют для взаимодействия друг с другом.
Документация API — это технический документ, содержащий инструкции по эффективному использованию и интеграции с API.
Основные требования к документации API такие же, как и к любому техническому документу: она должна быть легкой для понимания, простой в использовании и всегда актуальной.
Программисты часто создают документацию API с помощью различных инструментов, но у такого подхода есть минусы по сравнению с профессиональными решениями для технической документации. Многие программисты считают, что авто-сгенерированная документация достаточно хороша, но в большинстве случаев это не так. Продвинутые решения для технической документации позволяют форматировать и оформлять фрагменты кода, настраивать внешний вид документации, создавать удобную навигацию и использовать поиск, а также предоставляют множество других возможностей. Нет необходимости создавать веб-сайт или страницу в WordPress для размещения документации API — многие современные системы управления контентом предлагают облачный портал для онлайн-документации.