Я разработал довольно расширенный API, и у меня он есть на Postman, который работает довольно хорошо. Теперь мне нужно сгенерировать html-документ, чтобы он поддерживал его версией внутри/docs вместе с моими источниками.Создание html doc из коллекции почтальона
Есть ли способ или способ достижения этого? Я действительно не хочу писать всю эту документацию. Обмен коллекцией почтальонов не является вариантом.
У меня недавно была такая же проблема, и я ничего не нашел. Поэтому я создал простой инструмент для этого. Это очень простое приложение для 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 для создания разовой документации из Коллекций.
Черт! Спасибо ... – mccbala
Добро пожаловать. Благодаря вам. –
Похож на отличный проект. Однако его немного иронично, что в инструменте для создания документации нет документации о том, как ее использовать. Когда вы говорите, вставьте свою коллекцию почтальонов, что именно вы имеете в виду? – Chakaitos
Я знаю, что это старый вопрос, и вы, вероятно, нашли решение сейчас, но все же вы можете быть заинтересованы по Postmanerator: https://github.com/aubm/postmanerator
В принципе, это то, как вы используете его из командной строки:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Чтобы установить его, загрузите последнюю версию Github. Вам нужно выбрать соответствующий бинарный файл в зависимости от вашей системы. Затем поместите его где-нибудь в свой ПУТЬ.
См. Документацию в README, если вы хотите получить дополнительную информацию. Оттуда вы найдете рекомендации для полного использования инструмента или изменения внешнего вида вашей документации с помощью пользовательских тем.
Презентация Github также предоставляет ссылку на сгенерированную документацию примера.
Вы также узнаете, как вы можете использовать платформу CI, такую как Travis, для автоматизации генерации и публикации вашей документации с помощью Postmanerator.
Поскольку это проект с открытым исходным кодом, над которым я сейчас работаю, не стесняйтесь сообщать о проблемах в Github, если у вас есть идеи, которые могут улучшить его.
Вы также можете попробовать бесплатный инструмент, который я сделал. Он предоставляет документацию в формате .txt, но вы можете преобразовать ее в pdf с помощью своего браузера.
Вы можете установить Newman с помощью команды «NPM установить -g Newman», а затем выполнить команду «Ньюман запустить CollectionName.json -e envVar.json» от места, где вы сохранили свою коллекцию, где CollectionName.json - это имя вашей коллекции, а enVar.json - это набор переменных среды. Это создаст html-отчет в той же папке. Первым обязательным условием является установка узла js.
Вот мой, который генерирует файлы '.md' через скрипт python https://github.com/Avinash-Raj/docs-from-POSTMAN –