Użyłem interfejsu użytkownika Swagger do wyświetlenia moich usług sieci Web REST i hostowałem je na serwerze.
Jednak ta usługa Swaggera jest dostępna tylko na określonym serwerze. Jeśli chcę pracować w trybie offline, czy ktoś wie, jak mogę utworzyć statyczny plik PDF za pomocą interfejsu Swagger UI i pracować z nim? Ponadto plik PDF można łatwo udostępnić osobom, które nie mają dostępu do serwera.
Wielkie dzięki!
pdf
swagger-ui
Aman Mohammed
źródło
źródło
Wymyśliłem sposób, używając https://github.com/springfox/springfox i https://github.com/RobWin/swagger2markup
Użyłem Swaggera 2 do wykonania dokumentacji.
źródło
Możesz zmodyfikować swój projekt REST, aby podczas budowania projektu tworzyć potrzebne dokumenty statyczne (html, pdf itp.).
Jeśli masz projekt Java Maven, możesz użyć poniższego fragmentu kodu. Wykorzystuje szereg wtyczek do generowania pliku PDF i dokumentacji html (zasobów REST projektu).
Należy pamiętać, że kolejność wykonywania ma znaczenie, ponieważ wyjście jednej wtyczki staje się wejściem do następnej:
Wtyczka asciidoctor zakłada istnienie pliku adoc do pracy. Możesz utworzyć taki, który po prostu zbiera te, które zostały utworzone przez wtyczkę swagger2markup:
Jeśli chcesz, aby wygenerowany dokument html stał się częścią twojego pliku wojennego, musisz upewnić się, że znajduje się on na najwyższym poziomie - pliki statyczne w folderze WEB-INF nie będą obsługiwane. Możesz to zrobić za pomocą wtyczki maven-war:
Wtyczka war działa na wygenerowanej dokumentacji - w związku z tym musisz upewnić się, że te wtyczki zostały wykonane we wcześniejszej fazie.
źródło
Stworzyłem witrynę internetową https://www.swdoc.org/, która konkretnie odnosi się do problemu. Więc automatyzuje
swagger.json -> Asciidoc, Asciidoc -> pdf
transformację, jak sugerowano w odpowiedziach. Zaletą tego jest to, że nie musisz przechodzić przez procedury instalacji. Akceptuje dokument specyfikacji w postaci adresu URL lub po prostu surowego pliku json. Projekt jest napisany w C #, a jego strona to https://github.com/Irdis/SwDocEDYTOWAĆ
Dobrym pomysłem może być sprawdzenie poprawności specyfikacji json tutaj: http://editor.swagger.io/, jeśli masz jakiekolwiek problemy z SwDoc, takie jak niekompletny generowany plik PDF.
źródło
Do kasy https://mrin9.github.io/RapiPdf niestandardowy element z dużą ilością funkcji dostosowywania i lokalizacji.
źródło
Dla mnie najłatwiejszym rozwiązaniem było zaimportowanie swaggera (v2) do Postmana, a następnie przejście do widoku internetowego. Tam możesz wybrać widok „pojedynczej kolumny” i użyć przeglądarki, aby wydrukować do formatu PDF. Nie jest to rozwiązanie zautomatyzowane / zintegrowane, ale dobre do jednorazowego użytku. Obsługuje szerokość papieru znacznie lepiej niż drukowanie z editor2.swagger.io, gdzie paski przewijania powodują ukrywanie części treści.
źródło