Я разработал довольно обширный API, и он у меня есть на Postman, который работает довольно хорошо. Теперь мне нужно сгенерировать html-документ, чтобы сохранить его версию внутри /docs вместе с моими источниками.
Есть ли инструмент или способ добиться этого? Я действительно не хочу писать всю эту документацию. Совместное использование коллекции почтальона не вариант.
У меня недавно была такая же проблема, и я ничего не нашел. Поэтому я создал простой инструмент для этого. Это очень простое javascript-приложение, написанное с помощью react.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
ОБНОВЛЕНИЕ2: запрос функции (см. ОБНОВЛЕНИЕ1) закрыт, а возможность создания документации добавлена в облако Postman. Вот заключительный комментарий запроса функции:
Это доступно как часть Postman Cloud: http://blog.getpostman.com/2015/12/10/introduction-postman-cloud/. Облачные хосты, обновления и ведение документации для всех. Я бы предложил http://docman.launchrock.com/ и https://github.com/JakeWorrell/docodile для создания одноразовой документации из коллекций.
... в своей коллекции, а затем Export. Необработанное содержимое JSON этого файла затем можно вставить в инструмент создания документации @DavideVernizzi.
- person Pierre Thalamy; 17.05.2017
Я знаю, что это старый вопрос, и вы, вероятно, уже нашли решение, но все же вас может заинтересовать 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, если у вас есть какие-либо идеи, которые могут его улучшить.
Вы можете установить Newman с помощью команды «npm install -g Newman», а затем запустить команду «newman run CollectionName.json -e envVar.json» из места, где вы сохранили свою коллекцию, где CollectionName.json — это имя вашей коллекции, а enVar. .json — это набор переменных среды. Это создаст отчет в формате html в той же папке. Одним из предварительных условий является наличие установленного узла js.
Вы также можете попробовать бесплатный инструмент, который я сделал. Он предоставляет документацию в формате .txt, но вы можете преобразовать ее в pdf с помощью браузера.
https://postmandoc.herokuapp.com/
.mdфайлов с помощью скрипта Python github.com/Avinash-Raj/docs -от-POSTMAN - person Avinash Raj schedule 06.05.2016