ApiDoc

• Это плагин, с помощью которого можно генерировать ApiDoc на основе запроса в контроллере.

• Обратите внимание: этот плагин предназначен только для IntelliJ IDEA.

• Этот плагин разработан для модели npm apidoc, Домашняя страница, команда установки npm i apidoc.

Установка

• С помощью встроенной системы плагинов IDE на Windows:
  • Файл > Настройки > Плагины > Поиск репозиториев... > Найти «ApiDoc» > Установить плагин.
• С помощью встроенной системы плагинов IDE на MacOs:
  • Предпочтения > Настройки > Плагины > Поиск репозиториев... > Найти «ApiDoc» > Установить плагин.
• Вручную:
  • Загрузите последнюю версию из официального магазина JetBrains и установите её вручную с помощью Настройки > Плагины > Установить плагин с диска....

Использование

Используйте меню IDE

Используйте горячую клавишу

По умолчанию Option + Ctrl + Shift + p (Mac), Alt + Ctrl + Shift + p (Win).

Примеры

• Этапы операции

• Используйте команду npm apidoc для создания HTML

Информация о версии

v3.0.5

• Новые функции: поддержка имени поля вывода в стиле snake case.

v3.0.4

• Новые функции: Поддержка метода запроса PATCH.

v3.0.2

• Новые функции: Поддержка класса параметров запроса MultipartFile.

v3.0.1

• Новые функции: Постоянная версия.

v3.0.0

• Поддержка версий начиная с 192.
• Разрешение конфликта: тайм-аут.

v2.3

• Исправление ошибки: URL запроса.

V2.2

• Исправление ошибки: ошибка синтаксического анализа параметра с аннотацией @RequestBody в некоторых случаях, например, List<Object>, Object[].

v2.1

• Добавление pluginIcon.svg.
• Исправление ошибки: Ошибка генерации примера данных в некоторых случаях.

v2.0

• Поддержка IDEA более ранних версий, начиная с 192+.

v1.8

• Исправление ошибки: Неподдерживаемый URL запроса с атрибутом аннотации path.
• Исправление ошибки: Ошибки синтаксического анализа общих параметров в некоторых случаях.
• Создание ветки 191 для поддержки IDEA (162.* — 191.*).

v1.7

• Оптимизация интерфейса UI: добавление кнопки Повторно сгенерировать пример.

v1.6

• Решение конфликта: столкновение имён компонентов JavaDocWriter.

v1.5

• Добавить настройки плагина ApiDoc: поддержка установки параметра извлечь свойства объекта максимальная глубина.

v1.4

• Оптимизация пользовательского интерфейса.

v1.3

• Поддержка IDEA ранних версий, начиная с 162+.
• Исправление ошибок: поддержка специальных типов psiField, таких как BigInteger, итерируемые классы...
• Исправление ошибок: удаление устаревших полей.

v1.2

• Оптимизация генерации примеров данных.
• Оптимизация интерфейса UI.

v1.1

• Автоматическое создание примеров данных.
• Оптимизация интерфейса UI.
• Исправление ошибок: описание поля должно поддерживать специальный символ пробел.

v1.0

Первая версия.

• Поддержка операций UI.
• Поддерживает только публичные методы в контроллерах с аннотациями, связанными с HTTP-запросами.
• Предоставляет ярлык для открытия ApiDoc, по умолчанию Option + Ctrl + Shift + p (Mac), Alt + Ctrl + Shift + p(Win).
• Поддерживает генерацию apidoc.
• Поддерживает изменение документа с функцией памяти.