Создание html doc из коллекции postman [закрыто]
Я разработал довольно extense API, и у меня есть его на Postman, который работает довольно хорошо. Теперь мне нужно создать HTML-документ, чтобы сохранить его версию внутри /docs вместе с моими источниками.
есть ли инструмент или способ достичь этого? Я действительно не хочу писать всю эту документацию. Совместное использование коллекции postman не является вариантом.
4 ответов
У меня недавно была такая же проблема и я ничего не нашел. Поэтому я создал простой инструмент для этого. Это очень простое приложение 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
UPDATE2: запрос функции (см. UPDATE1) был закрыт, и возможность создания документации была добавлена в Postman cloud. Вот комментарий к закрытию запроса функции:
Это доступно в составе 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. Вам нужно выбрать соответствующий двоичный файл в зависимости от вашей системы. Затем поместите его где-нибудь на своем пути.
см. документацию в README, если вам нужна дополнительная информация. Оттуда вы найдете рекомендации для принятия полного расширения инструмента или изменить внешний вид документации с помощью пользовательских тем.
презентация Github также содержит ссылку на сгенерированную документацию примера.
вы также узнаете, как вы можете воспользоваться платформой CI, такой как Travis, для автоматизации генерации и публикации Вашей документации с помощью Postmanerator.
поскольку это проект с открытым исходным кодом, над которым я сейчас работаю, не стесняйтесь отправлять вопросы на Github, если у вас есть идеи, которые могут сделать его лучше.
вы также можете попробовать бесплатный инструмент, который я сделал. Он предоставляет документацию .txt, но вы можете преобразовать его в PDF с помощью браузера.
вы можете установить Newman с помощью команды "npm install-g Newman", а затем запустить команду " newman run CollectionName.json-e envVar.json " из места, где вы сохранили свою коллекцию, где CollectionName.json-это имя вашей коллекции и enVar.JSON-это набор переменных среды. Это создаст отчет html в той же папке. Одним из необходимых условий является установка узла js.