---
title: "API документация"
id: "api-dokumentatsiya"
project: "Руководство пользователя Документерры"
url: "https://docs.documenterra.ru/articles/manual/api-dokumentatsiya"
keywords:
  - "API"
  - "json"
  - "OpenAPI"
  - "Swagger"
  - "yaml"
updated: 2026-11-16T06:45:50Z
---

# API документация

Документерра позволяет автоматически создавать API-документацию из файлов OpenAPI в форматах **.json**или **.yaml** и размещать её вместе с вашими руководствами пользователей. Обновить API-документацию в соответствии с новыми исходными файлами очень просто - для этого достаточно нажать кнопку **Обновить**.

| Если вы ищите информацию о функциональности API Документерры, пожалуйста, перейдите в раздел [API Документерры](/articles/manual/api-dokumenterry). |
| --- |

Страницы, созданные с помощью импорта спецификаций OpenAPI, называются автоматически сгенерированными страницами. Чтобы узнать больше о создании и обновлении таких страниц, пожалуйста, ознакомтесь с соответствующим разделом: [Автоматически сгенерированные страницы](/articles/manual/avtomaticheski-sgenerirovannyye-stranitsy).

Вот пример атоматически сгенерированной страницы API-документации на основе примера [Swagger Petstore](https://petstore.swagger.io/): ![Автоматически сгенерированная страница из примера Swagger Petstore](/resources/Storage/manual/api-dokumentatsiya/swagger_petstore_example.png)

Слева находится информация о запросе: его описание, параметры, схемы тела запроса и ответы. Справа — примеры запросов и ответов, а также интерактивная панель для тестирования запросов.

## Интерактивная API-документация - тестирование запросов

Документерра генерирует интерактивную API-документацию на основе ваших спецификаций. Это означает, что ваши читатели могут тестировать API-запросы прямо из браузера, используя кнопку **Test Request**.![Кнопка Try Out в автоматически сгенерированной странице](/resources/Storage/manual/api-dokumentatsiya/try-out-button.png)

После нажатия кнопки вам будет предложено указать данные для аутентификации, параметры, заголовки и т.д., если это необходимо, и отправить тестовый запрос. Для того чтобы отправить запрос нажмите кнопку **Send**.![Пример окна, которое вы увидите после нажатия кнопки &quot;Test Request&quot;](/resources/Storage/manual/api-dokumentatsiya/test-request-window.png)

Больше информации об этом вы можете найти здесь: [Попробуйте интерактивную API-документацию](/articles/manual/poprobuyte-interaktivnuyu-api-dokumentatsiyu).