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

如何导出PDF和XML文件中的Swagger文档,pdf,asp.net-web-api,swagger,swagger-ui,chm,Pdf,Asp.net Web Api,Swagger,Swagger Ui,Chm,我已使用以下链接为web api生成了swagger文档: 需要导出PDF或XML文件格式的文档,以便发送到各个站点 它的.NETWebAPI 如何导出swagger文档 谢谢GitHub上有招摇过市项目,您也可以通过谷歌找到更多信息 Swagger2Markup将一个Swagger JSON或YAML文件转换为几个AsciiDoc或GitHub风格的标记文档,这些文档可以与手写文档结合使用 比降价更好,因为它有更多的功能。Ascidoc是一种文本文档格式,用于编写文档、文章、书籍、电子书、幻

我已使用以下链接为web api生成了swagger文档:

需要导出PDF或XML文件格式的文档,以便发送到各个站点

它的.NETWebAPI

如何导出swagger文档


谢谢GitHub上有招摇过市项目,您也可以通过谷歌找到更多信息

Swagger2Markup将一个Swagger JSON或YAML文件转换为几个AsciiDoc或GitHub风格的标记文档,这些文档可以与手写文档结合使用

比降价更好,因为它有更多的功能。Ascidoc是一种文本文档格式,用于编写文档、文章、书籍、电子书、幻灯片、网页和博客。ascidoc文件可以转换为HTML、PDF和EPUB。与JavaDoc或注释相比,Ascidoc更适合描述公共API

您可以通过ascidoctorj生成HTML5、PDF和EPUB文档,或者通过ascidoctorGradle插件或ascidoctorMaven插件生成更好的文档

该项目至少需要JDK 8

另请参见

您可以使用和docker图像:

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”的ASCIDOC文件

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

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

他们没有将swagger文档导出为PDF或任何其他文档的工具或功能。您需要将swagger.json文件转换为yaml文件,然后您可以将swagger转换为html文档格式

以下是我今天所做的,因为许多其他项目需要费力的变通方法、额外的库或一些完全独立的语言

docker run -it -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf swagger-doc.adoc
  • 转到(确保它是HTTPS版本)
  • 在顶部,单击
    文件
    =>
    导入文件
  • 选择您的Swagger JSON文件
  • 在顶部,单击
    generateclient
    =>
    HTML2
    并下载ZIP文件

这将生成一个静态HTML页面,然后您可以使用内置的Microsoft print to PDF打印机或Adobe Acrobat或您可能想使用的任何其他工具(通过浏览器)将其打印为PDF。

可能与FYI重复,此容器不会安装在Windows上。考虑到使用.NET特别提到的询问者,想到他安装整个JDK环境只是为了将一个JSON文件打印成PDF,真是有趣!这就像买一辆本田车去你的福特汽车配件店一样。