Я разработал довольно обширный API, и у меня есть его на Postman, который работает довольно хорошо. Теперь мне нужно создать html-документ, чтобы он поддерживал его версией внутри /docs вместе с моими источниками.
Есть ли инструмент или способ достичь этого? Я действительно не хочу писать всю эту документацию. Совместное использование коллекции почтальонов не является вариантом.
Недавно у меня была такая же проблема, и я ничего не нашел. Поэтому я создал простой инструмент для этого. Это очень простое приложение для javascript, написанное с помощью response.js. На данный момент это очень просто, но я работаю над этим, поэтому любой запрос функции приветствуется.
Вы можете использовать его бесплатно по адресу: http://www.vernizzis.it/docman/
Плюс вы можете получить код и изменить его по адресу: https://github.com/davidevernizzi/docman
Любые комментарии более чем приветствуются.
UPDATE1: оглядевшись, я также нашел этот проект: https://github.com/JakeWorrell/docodile и этот запрос функции: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
UPDATE2: запрос функции (см. UPDATE1) был закрыт, и возможность создания документации была добавлена в облако почтмана. Вот комментарий закрытия запроса функции:
Это доступно как часть Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Облачные хосты, обновляют и поддерживают документацию для всех. Я предлагаю http://docman.launchrock.com/ и https://github.com/JakeWorrell/docodile для создания одноразовой документации из Коллекций.
Я знаю, что это старый вопрос, и вы, вероятно, нашли решение уже сейчас, но все равно вас может заинтересовать Postmanerator: https://github.com/aubm/postmanerator
В основном, так вы используете его из командной строки:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Чтобы установить его, загрузите последнюю версию Github. Вам нужно выбрать соответствующий бинарный файл в зависимости от вашей системы. Затем поместите его где-нибудь в свой PATH.
См. документацию в README, если вы хотите получить дополнительную информацию. Оттуда вы найдете рекомендации для полного использования инструмента или изменения внешнего вида вашей документации с помощью пользовательских тем.
В презентации Github также содержится ссылка на документацию сгенерированного примера.
Вы также узнаете, как вы можете использовать платформу CI, такую как Travis, для автоматизации генерации и публикации вашей документации с помощью Postmanerator.
Поскольку это проект с открытым исходным кодом, над которым я сейчас работаю, не стесняйтесь сообщать о проблемах в Github, если у вас есть идеи, которые могут улучшить его.
Вы также можете попробовать бесплатный инструмент, который я создал. Он предоставляет документацию в формате .txt, но вы можете преобразовать ее в pdf с помощью своего браузера.
Вы можете установить Newman, используя команду "npm install -g Newman", а затем запустить команду "newman run CollectionName.json -e envVar.json" из того места, где вы сохранили свою коллекцию, где CollectionName.json - ваша коллекция name и enVar.json - это набор переменных среды. Это создаст html-отчет в той же папке. Одним из условий является установка node js.