2015-03-24 23 views
14

Oldukça güzel bir API geliştirdim ve Postman'da oldukça güzel çalışıyor. Şimdi kendi içeriğimdeki/dokümanlarımda bulunan kaynaklarla birlikte tutmak için bir html belgesi oluşturmam gerekiyor.Postacı koleksiyonundan html doc oluşturma

Bunu başarmak için bir araç veya yol var mı? Tüm bu belgeleri yazmak istemiyorum. Postacı koleksiyonunu paylaşmak bir seçenek değildir.

+1

İşte benim, python komut dosyası aracılığıyla .md' dosyalarını üreten https://github.com/Avinash-Raj/docs-from-POSTMAN –

cevap

23

Son zamanlarda aynı problemi yaşadım ve hiçbir şey bulamadım. Bu yüzden bunu yapmak için basit bir araç oluşturdum. React.js ile yazılmış çok basit bir javascript uygulamasıdır. Şu anda çok basit, ama üzerinde çalışıyorum, bu yüzden herhangi bir özellik isteği açıktır.

Sen de ücretsiz olarak kullanabilirsiniz: http://www.vernizzis.it/docman/

Artı kodu almak ve en değiştirebilirsiniz: https://github.com/davidevernizzi/docman

Herhangi bir yorum karşılama daha fazladır.

UPDATE1: https://github.com/JakeWorrell/docodile ve bu özellik isteği: https://github.com/a85/POSTMan-Chrome-Extension/issues/204

Update2: Ben de bu projeyi bulundu etrafa özellik isteği (Update1 bakınız) kapatıldıktan ve dokümantasyon oluşturma olasılığını Postacı bulutu eklendi . İşte özellik talebi kapanış yorumu:

Bu, Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/'un bir parçası olarak kullanılabilir. Cloud, herkes için belgeleri barındırır, günceller ve saklar. Koleksiyonlardan bir kerelik dokümantasyon oluşturmak için http://docman.launchrock.com/ ve https://github.com/JakeWorrell/docodile önermeliyim.

+0

Lanet olsun! Teşekkürler ... – mccbala

+0

Çok hoş geldiniz. Sayende. –

+5

Harika bir proje gibi görünüyor. Bununla birlikte, belgelerin üretilmesi için bir aracın, nasıl kullanılacağına dair bir belgeye sahip olmaması biraz ironiktir. Postacı koleksiyonunuzu yapıştır dediğinizde, tam olarak ne demek istiyorsunuz? – Chakaitos

11

Bu eski bir soru olduğunu biliyorum ve muhtemelen şimdi bir çözüm buldu, ama hala Postmanerator tarafından ilginizi çekebilir: https://github.com/aubm/postmanerator

Temelde, bu komut satırından nasıl kullandığımız:

postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html 

Yüklemek için en son Github sürümünü indirin. Sisteminize bağlı olarak uygun ikiliyi seçmeniz gerekir. Ardından, PATH'nuza bir yere koyun.

Ek bilgi isterseniz README'deki belgelere bakın. Buradan, aracın tüm avantajlarından yararlanmaya yönelik tavsiyelerde bulunacak veya özel temalar kullanarak belgelerinizin görünümünü değiştireceksiniz.

Github sunumu ayrıca oluşturulan örnek belgelere bir başvuru sağlar.

Ayrıca, Postmanerator ile belgelerinizin oluşturulmasını ve yayınlanmasını otomatikleştirmek için Travis gibi bir CI platformundan nasıl yararlanabileceğinizi keşfedeceksiniz.

Şu anda üzerinde çalıştığım bir açık kaynak kodlu bir proje olduğundan, Github hakkında daha iyi hale getirebilecek herhangi bir fikriniz varsa, çekinmeden başvuruda bulunabilirsiniz.

0

Yaptığım ücretsiz aracı da deneyebilirsiniz. Dokümanları .txt olarak sağlar, ancak tarayıcınızı kullanarak pdf'ye dönüştürebilirsiniz.

https://postmandoc.herokuapp.com/

0

Sen nereye komut size toplama kaydettiğiniz yerden komut "envVar.json -e CollectionName.json çalıştırmak Newman" çalıştırmak ardından "npm Newman -g yükle" ve kullanan Newman kurabilirsiniz CollectionName.json sizin koleksiyonunuzun adıdır ve enVar.json ortam değişkenleri kümesidir. Bu, aynı klasörde html raporu oluşturur. Bir önkoşul, düğüm j'lerinin kurulmasını sağlamaktır.