Документация по API | Qlik Cloud Справка
Перейти к основному содержимому Перейти к дополнительному содержимому

Документация по API

API Designer позволяет документировать ваш API. Документация — важный этап жизненного цикла API. Написание и поддержка документации могут быть сложными, но API Designer позволяет получать документацию автоматически.

Кто пишет документацию и кто ее читает?

В API Designer вы работаете в команде проектировщиков API, которым разрешено редактировать дизайн вашего API. Члены вашей команды могут вносить свой вклад в документацию вашего API и генерировать предварительный просмотр в реальном времени.

Живой документацией (Live Documentation) можно делиться с членами вашей команды, партнерами или любыми другими лицами, которым может понадобиться доступ к ней, пока она еще находится в стадии разработки.

Помогла ли вам эта страница?

Если вы обнаружили какую-либо проблему на этой странице или с ее содержанием — будь то опечатка, пропущенный шаг или техническая ошибка, сообщите нам об этом!