Generate PDF from Swagger API documentation

Question

I have used the Swagger UI to display my REST webservices and hosted it on a server   However this service of Swagger can only be accessed on a particular server  If I want to work offline  does anybody know how I can create a static PDF using the Swagger UI and work with it  Additionally a PDF is easy to share with people who don t have access to the server   Many thanks

User · Accepted Answer

I figured out a way using https   github com springfox springfox and  https   github com RobWin swagger2markup  Used Swagger 2 to implement documentation

User · Answer

You can modify your REST project  so as to produce the needed static documents  html  pdf etc  upon building the project   If you have a Java Maven project you can use the pom snippet below  It uses a series of plugins to generate a pdf and an html documentation  of the project s REST resources     rest-api        -  swagger json     swagger-maven-plugin swagger json    -  Asciidoc         swagger2markup-maven-plugin Asciidoc        -  PDF              asciidoctor-maven-plugin   Please be aware that the order of execution matters  since the output of one plugin  becomes the input to the next    lt plugin gt       lt groupId gt com github kongchen lt  groupId gt       lt artifactId gt swagger-maven-plugin lt  artifactId gt       lt version gt 3 1 3 lt  version gt       lt configuration gt           lt apiSources gt               lt apiSource gt                   lt springmvc gt false lt  springmvc gt                   lt locations gt some package lt  locations gt                   lt basePath gt  api lt  basePath gt                   lt info gt                       lt title gt Put your REST service s name here lt  title gt                       lt description gt Add some description lt  description gt                       lt version gt v1 lt  version gt                   lt  info gt                   lt swaggerDirectory gt   project build directory  api lt  swaggerDirectory gt                   lt attachSwaggerArtifact gt true lt  attachSwaggerArtifact gt               lt  apiSource gt           lt  apiSources gt       lt  configuration gt       lt executions gt           lt execution gt               lt phase gt   phase generate-documentation  lt  phase gt               lt  -- fx process-classes phase -- gt               lt goals gt                   lt goal gt generate lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt   lt plugin gt       lt groupId gt io github robwin lt  groupId gt       lt artifactId gt swagger2markup-maven-plugin lt  artifactId gt       lt version gt 0 9 3 lt  version gt       lt configuration gt           lt inputDirectory gt   project build directory  api lt  inputDirectory gt           lt outputDirectory gt   generated asciidoc directory  lt  outputDirectory gt           lt  -- specify location to place asciidoc files -- gt           lt markupLanguage gt asciidoc lt  markupLanguage gt       lt  configuration gt       lt executions gt           lt execution gt               lt phase gt   phase generate-documentation  lt  phase gt               lt goals gt                   lt goal gt process-swagger lt  goal gt               lt  goals gt           lt  execution gt       lt  executions gt   lt  plugin gt   lt plugin gt       lt groupId gt org asciidoctor lt  groupId gt       lt artifactId gt asciidoctor-maven-plugin lt  artifactId gt       lt version gt 1 5 3 lt  version gt       lt dependencies gt           lt dependency gt               lt groupId gt org asciidoctor lt  groupId gt               lt artifactId gt asciidoctorj-pdf lt  artifactId gt               lt version gt 1 5 0-alpha 11 lt  version gt           lt  dependency gt           lt dependency gt               lt groupId gt org jruby lt  groupId gt               lt artifactId gt jruby-complete lt  artifactId gt               lt version gt 1 7 21 lt  version gt           lt  dependency gt       lt  dependencies gt       lt configuration gt           lt sourceDirectory gt   asciidoctor input directory  lt  sourceDirectory gt           lt  -- You will need to create an  adoc file  This is the input to this plugin -- gt           lt sourceDocumentName gt swagger adoc lt  sourceDocumentName gt           lt attributes gt               lt doctype gt book lt  doctype gt               lt toc gt left lt  toc gt               lt toclevels gt 2 lt  toclevels gt               lt generated gt   generated asciidoc directory  lt  generated gt               lt  -- this path is referenced in swagger adoc file  The given file will simply                  point to the previously create adoc files assemble them  -- gt           lt  attributes gt       lt  configuration gt       lt executions gt           lt execution gt               lt id gt asciidoc-to-html lt  id gt               lt phase gt   phase generate-documentation  lt  phase gt               lt goals gt                   lt goal gt process-asciidoc lt  goal gt               lt  goals gt               lt configuration gt                   lt backend gt html5 lt  backend gt                   lt outputDirectory gt   generated html directory  lt  outputDirectory gt                   lt  -- specify location to place html file -- gt               lt  configuration gt           lt  execution gt           lt execution gt               lt id gt asciidoc-to-pdf lt  id gt               lt phase gt   phase generate-documentation  lt  phase gt               lt goals gt                   lt goal gt process-asciidoc lt  goal gt               lt  goals gt               lt configuration gt                   lt backend gt pdf lt  backend gt                   lt outputDirectory gt   generated pdf directory  lt  outputDirectory gt                   lt  -- specify location to place pdf file -- gt               lt  configuration gt           lt  execution gt       lt  executions gt   lt  plugin gt    The asciidoctor plugin assumes the existence of an  adoc file to work on   You can create one that simply collects the ones that were created by the swagger2markup plugin   include   generated  overview adoc   include   generated  paths adoc   include   generated  definitions adoc     If you want your generated html document to become part of your war file you have to make sure that it is present on the top level - static files in the WEB-INF folder will not be served   You can do this in the maven-war-plugin    lt plugin gt       lt artifactId gt maven-war-plugin lt  artifactId gt       lt configuration gt           lt warSourceDirectory gt WebContent lt  warSourceDirectory gt           lt failOnMissingWebXml gt false lt  failOnMissingWebXml gt           lt webResources gt               lt resource gt                   lt directory gt   generated html directory  lt  directory gt               lt  -- Add swagger pdf to WAR file  so as to make it available as static content  -- gt               lt  resource gt               lt resource gt                   lt directory gt   generated pdf directory  lt  directory gt               lt  -- Add swagger html to WAR file  so as to make it available as static content  -- gt               lt  resource gt           lt  webResources gt       lt  configuration gt   lt  plugin gt    The war plugin works on the generated documentation - as such  you must make sure that those plugins have been executed in an earlier phase

User · Answer

For me the easiest solution was to import swagger  v2  into Postman and then go to the web view  There you can choose  single column  view and use the browser to print to pdf  Not a automated integrated solution but good for single-use  It handles paper-width much better than printing from editor2 swagger io  where scrollbars cause portions of the content to be hidden

User · Answer

Handy way  Using Browser Printing Preview   Hide editor pane Print Preview  I used firefox  others also fine  Change its page setup and print to pdf

User · Answer

I created a web site https   www swdoc org  that specifically addresses the problem  So it automates swagger json - gt  Asciidoc  Asciidoc - gt  pdf transformation as suggested in the answers  Benefit of this is that you dont need to go through the installation procedures  It accepts a spec document in form of url or just a raw json  Project is written in C  and its page is https   github com Irdis SwDoc EDIT It might be a good idea to validate your json specs here  http   editor swagger io  if you are having any problems with SwDoc  like the pdf being generated incomplete

User · Answer

Checkout https   mrin9 github io RapiPdf a custom element with plenty of customization and localization feature      Disclaimer  I am the author of this package

[pdf] Generate PDF from Swagger API documentation

Examples related to pdf

Examples related to swagger-ui