如何在PDF和XML文件中导出Swagger文档

Question

我使用以下链接为web api生成了一个swagger文档： http://wmpratt.com/swagger-and-asp-net-web-api-part-1/

需要导出PDF或XML文件中的文档以便发送。

其.NET WEB API。

如何导出swagger文档？

由于

Answer 1

您可以使用Swagger2Markup和AsciiDoc码头工人图像：

docker run --rm -v $(pwd):/opt swagger2markup/swagger2markup convert -i "https://api.example.org/api/doc/swagger.json" -f /opt/swagger-doc

在当前文件夹中创建名为“ swagger-doc.adoc”的asciidoc文件。

docker run -it -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf swagger-doc.adoc

在当前文件夹中创建一个名为“ swagger-doc.pdf”的PDF文件。

Answer 2

这就是我今天要做的，因为许多其他项目都需要费力的解决方法或额外的库或某些完全独立的语言。

• 转到https://editor.swagger.io/（确保它是HTTPS版本）
• 在顶部，单击File => Import File。
• 选择您的Swagger JSON文件。
• 在顶部，单击Generate Client => HTML2并下载ZIP文件。

这将生成一个静态HTML页面，然后您可以使用内置的Microsoft Print to PDF打印机，Adobe Acrobat或其他任何您想使用的东西（通过浏览器）将其打印为PDF。

Answer 3

Swagger2Markup 项目在GitHub上，您也可以通过Google找到更多信息。

Swagger2Markup将Swagger JSON或YAML文件转换为几个可与手写文档结合的AsciiDoc或GitHub Flavored Markdown文档。

AsciiDoc比Markdown更受欢迎，因为它具有更多功能。 AsciiDoc是一种文本文档格式，用于编写文档，文章，书籍，电子书，幻灯片，网页和博客。 AsciiDoc文件可以转换为HTML，PDF和EPUB。 AsciiDoc比JavaDoc或Annotations更适合描述公共API。

您可以通过asciidoctorj生成HTML5，PDF和EPUB文档，甚至可以通过asciidoctor-gradle-plugin或asciidoctor-maven-plugin更好地生成。

该项目至少需要JDK 8.

另见RESTful API Documentation with Swagger and AsciiDoc

Answer 4

他们没有这样的工具或功能，无法将一般的文档导出为PDF或任何其他文档。您需要将swagger.json文件转换为yaml文件，然后您才能以html文档格式http://editor.swagger.io/的形式使用swagger。