Какие форматы исходных данных поддерживаются?

Инструмент поддерживает OpenAPI (Swagger) в форматах JSON и YAML, а также структурированные аннотированные комментарии.

В каких форматах можно скачать готовую документацию?

Вы можете экспортировать результат в виде интерактивного HTML-файла, Markdown-документа или PDF-файла.

Можно ли отключить вывод примеров кода и схем?

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

Что делать, если я не знаю точный формат своего исходного кода?

Выберите опцию «Автоопределение» в поле «Формат источника», и инструмент сам распознает JSON, YAML или комментарии.

Чем отличаются темы оформления?

Тема «Сланец» (Slate) предлагает современный темный дизайн для блоков кода, а «Бумага» (Paper) — классический светлый стиль, отлично подходящий для печати и PDF.

Elysia Tools

Навигация

Development

Генератор API Документации

Создает аккуратную API документацию из OpenAPI или аннотированных комментариев

Детали

С чем помогает этот инструмент

Преобразует OpenAPI/Swagger или структурированные комментарии в HTML, Markdown или PDF документацию с параметрами и примерами.

Запуск

Запустить этот инструмент

Заполните форму, запустите инструмент и посмотрите результат на этой же странице.

Подготовленные примеры запуска

Нажмите пример, чтобы автоматически заполнить форму. Файлы по-прежнему нужно загрузить.

2 примеров

Сгенерировать Markdown-документацию из OpenAPI

Преобразует компактный OpenAPI документ в Markdown-справочник с параметрами, ответами, схемами и ошибками.

# Demo User API Version: 1.2.0 ## Endpoints ### GET /users/{id} **Summary:** Get user by ID

Преобразовать аннотированные комментарии в интерактивный HTML

Использует структурированные комментарии для создания HTML-страницы API без примеров и схем.

<article class="endpoint"><div class="endpoint-header"><span class="method">POST</span><code>/invoices</code></div><h3>Create invoice</h3>

Ввод

Заполните нужные поля и запустите инструмент.

7 параметров

СодержимоеВставьте или введите основные значения.2

Источник APItextareaОбязательноЗаголовок документаtextНеобязательно

НастройкиНастройте форматы, диапазоны, числа и режимы.3

Формат источникаselectНеобязательноФормат выводаselectНеобязательноТемаselectНеобязательно

ПереключателиВключайте или отключайте дополнительные режимы.2

Добавить примерыcheckboxНеобязательноВключено, если отмеченоДобавить схемыcheckboxНеобязательноВключено, если отмечено

Результат

Готово к запуску

После запуска здесь появятся файлы, текст, структурированные данные или потоковый вывод.

Примеры

Примеры для этого инструмента

Связано

Генератор API Документации

С чем помогает этот инструмент

Запустить этот инструмент

Подготовленные примеры запуска

Ввод

Результат

Примеры для этого инструмента

Продолжить с похожими инструментами и темами

Подготовленные примеры запуска

Ввод

Результат

Узнайте, когда использовать этот инструмент, что он поддерживает и как его применяют пользователи.

Ключевые факты

Обзор

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

Как это работает

Сценарии использования

Примеры

1. Создание Markdown-справочника из OpenAPI

2. Генерация HTML-документации из комментариев

FAQ

Примеры Markdown Презентаций

PDF Примеры

Примеры Markdown

Образцы просмотрщика Markdown

Генератор Data URI

Генератор отчета по аудиту доступности

Шаблоны Колонтитулов PDF

Генератор PDF-счетов

Инструменты для написания, извлечения и публикации документации

Инструменты OpenAPI для документации, кодогенерации и ревью контрактов

Инструменты для тестирования API-контрактов, моков и проверки схем

Инструменты для версионирования API, проверки breaking changes и готовности к релизу