postmanToWord

Очень ленив, не люблю писать документацию по интерфейсам. Сейчас использую Postman для тестирования интерфейсов, поэтому разработал этот инструмент для удобства быстрого преобразования JSON, экспортированного из Postman, в стандартную документацию по интерфейсам. 😂 😂

Postman

Преобразование JSON-файла типа Collection v2.1, экспортированного из Postman, в стандартную документацию по интерфейсам в формате Word.

Порядок действий

1. Запрос интерфейса в Postman и сохранение возвращаемого результата в пример.

2. Создание примера команды, обычно достаточно одного успешного и одного неуспешного возвращаемого результата.

3. Экспорт коллекции, содержащей этот интерфейс.

4. Экспорт версии v2.1.

5. Запуск проекта и вызов интерфейса convert для преобразования JSON в документацию по интерфейсам в формате Word.

6. Вызов интерфейса convert возвращает объект, основные данные запроса находятся в visitPath.

7. Открытие ссылки в visitPath приводит к загрузке документации по интерфейсам в формате Word.

Основные настраиваемые параметры

application.yml

app:
  fileDest: "F:/workspace/postmanToWord/uploads"
  filePathRoute: "/uploads/" # Путь для доступа к загруженным файлам
  fileVisitHost: "http://localhost:8888" # Хост для доступа к загруженным файлам