Серверные API

В One File Docs есть два серверных API: одно для обновления section, второе для сборки готового HTML-документа.

Какие API доступны

Обновление контента заменяет содержимое одного page или API Reference section.

Генерация документа собирает и возвращает итоговый HTML целиком.

Доступ

Оба API работают по секретному ключу и доступны только на тарифе Pro.

Когда использовать

Обновление контента подходит, когда нужно динамически обновлять конкретный section из внешнего источника без ручного редактирования в workspace.

Генерация документа подходит, когда нужно автоматизировать сборку документации и получать готовый HTML-документ из внешнего процесса, CI или внутреннего сервиса.