Opracowałem całkiem rozbudowany interfejs API i mam go na Postmanie, który działa całkiem nieźle. Teraz muszę wygenerować dokument html, aby zachować jego wersję wewnątrz/docs wraz z moimi źródłami.Tworzenie dokumentu html z kolekcji listonosza
Czy istnieje narzędzie lub sposób, aby to osiągnąć? Naprawdę nie chcę pisać całej tej dokumentacji. Udostępnianie kolekcji listonoszy nie jest opcją.
Niedawno miałem ten sam problem i nic nie znalazłem. Stworzyłem więc proste narzędzie do tego. Jest to bardzo prosta aplikacja javascript napisana przy pomocy pliku react.js. W tej chwili jest to bardzo proste, ale pracuję nad nim, więc każda prośba o funkcję jest mile widziana.
Można go używać za darmo pod adresem: http://www.vernizzis.it/docman/
Plus można pobrać kod i zmodyfikować go pod adresem: https://github.com/davidevernizzi/docman
Każdy komentarz jest bardziej niż mile widziane.
UPDATE1: rozglądać Znalazłem również ten projekt: https://github.com/JakeWorrell/docodile i ten wniosek cecha: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
Update2: wniosek funkcji (patrz UPDATE1) zostało zamknięte i możliwość tworzenia dokumentacji został dodany do Postman chmurze . Oto komentarz do zamknięcia żądania funkcji:
Jest to dostępne w ramach Cloud Postman: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Chmura hostuje, aktualizuje i przechowuje dokumentację dla wszystkich. Sugeruję http://docman.launchrock.com/ i https://github.com/JakeWorrell/docodile do generowania jednorazowej dokumentacji z Kolekcji.
Cholera dobrze! Dzięki ... – mccbala
Serdecznie witamy. Dzięki Tobie. –
Wygląda to świetny projekt. Jest jednak trochę ironiczne, że narzędzie do generowania dokumentacji nie ma dokumentacji, jak z niego korzystać. Kiedy mówisz o wklejeniu kolekcji listonosza, co dokładnie masz na myśli? – Chakaitos
wiem, że to jest stary pytanie i prawdopodobnie znalazł rozwiązanie teraz, ale nadal może być zainteresowany przez Postmanerator: https://github.com/aubm/postmanerator
Zasadniczo, jest to, w jaki sposób używać go z linii poleceń:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
Aby zainstalować, pobierz najnowszą wersję Github. Musisz wybrać odpowiedni plik binarny w zależności od systemu. Następnie umieść go gdzieś w swojej PATH.
Zobacz dokumentację w pliku README, jeśli chcesz uzyskać dodatkowe informacje. Stamtąd znajdziesz wskazówki, które pozwolą Ci w pełni wykorzystać narzędzia lub zmienić wygląd twojej dokumentacji, używając niestandardowych motywów.
Prezentacja Github zawiera również odniesienie do wygenerowanej przykładowej dokumentacji.
Dowiesz się również, jak wykorzystać platformę CI, taką jak Travis, do automatyzacji generowania i publikowania dokumentacji za pomocą programu Postmanerator.
Ponieważ jest to projekt o otwartym kodzie źródłowym, nad którym obecnie pracuję, możesz przesyłać problemy na Github, jeśli masz jakieś pomysły, które mogą go ulepszyć.
Możesz również wypróbować bezpłatne narzędzie, które utworzyłem. Udostępnia dokumentację w formacie .txt, ale można ją przekonwertować do formatu pdf za pomocą przeglądarki.
Można zainstalować Newman za pomocą polecenia „npm zainstalować -g Newman”, a następnie uruchomić „Newman uruchomić CollectionName.json -e envVar.json” poleceń z lokalizacji, w której został zapisany swoją kolekcję, gdzie CollectionName.json to nazwa twojej kolekcji, a enVar.json to zestaw zmiennych środowiskowych. Spowoduje to wygenerowanie raportu html w tym samym folderze. Jednym z warunków wstępnych jest zainstalowanie węzła js.
Oto moje, które generuje pliki '.md' za pośrednictwem skryptu python https://github.com/Avinash-Raj/docs-from-POSTMAN –