Создание документации из OpenAPI

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

Рабочая область

Обработка на устройстве. Файлы и текст не отправляются в аналитику. Ctrl/Cmd+Enter — запуск.

Загрузка локальной обработки…

Настройки

Настройки содержат параметры, без исходных файлов. Автоматического сохранения нет.

Метод и ограничения

Создаёт автономный HTML с навигацией по операциям, локальными моделями и экранированным содержимым контракта. Запросы к API и внешние $ref не выполняются.

Локальная обработка: до2 млн символов или20 000 записей на источник; до50 000 строк результата. Тяжёлые операции имеют отдельные ограничения и отмену. Измеренный спрос и внешние данные не подставляются.

Методика и примеры

Создание документации из OpenAPI

Создаёт автономный HTML с навигацией по операциям, локальными моделями и экранированным содержимым контракта. Запросы к API и внешние $ref не выполняются.

Входные данные примера

Основной источник

{
  "openapi": "3.1.0",
  "info": {
    "title": "Локальный API",
    "version": "1.0"
  },
  "paths": {
    "/items": {
      "get": {
        "summary": "Список элементов",
        "responses": {
          "200": {
            "description": "Успех"
          }
        }
      }
    }
  }
}

Результат примера

methodpathsummary
get/itemsСписок элементов

Показано строк: 1 из 1.

Локальная обработка: до2 млн символов или20 000 записей на источник; до50 000 строк результата. Тяжёлые операции имеют отдельные ограничения и отмену. Измеренный спрос и внешние данные не подставляются.

Источники метода

Следующая задача