swagger生成pdf接口文档操作流程

swagger生成pdf接口文档操作流程

参考链接：https://apifox.com/apiskills/how-to-export-swagger-md-pdf-word/

第一步：将 Swagger 导出为 JSON

打开 Swagger Petstore 开源项目，点击 swagger.json 文件，鼠标右键，将其存到电脑本地，如下图所示。

第二步：将 Swagger 文件导入 Apifox

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter，Apifox 支持调试 http（s）、WebSocket、Socket、gRPC、Dubbo 等协议的接口，并且集成了 IDEA 插件。在开发完接口后，可以通过 Apifox 的 IDEA 插件一键生成接口文档，多端同步，非常方便测试和维护。

Swagger 文件导入 Apifox

打开 Apifox，创建一个项目后，选择**“项目设置->导入数据->OpenAPI/Swagger->文件导入”**，将上一个步骤已导出的 Swagger 格式的 JSON 文件导入即可。

第三步：将文件导出为 Markdown

这样生成的文档是中文的，如果是英文文档需要修改Apifox为英文

第四步：生成pdf文档

将生成好的md文档在VScode中打开，下载两个插件

插件名	作用
Markdown PDF	生成pdf文档
Markdown All in One	生成md文档目录

Markdown All in One插件生成目录

1.安装扩展：Markdown All in One

2.配置扩展：

• 打开用户设置（File > Preferences > Settings 或者快捷键 Ctrl+,）。
• 搜索 markdown.allinone.toc.levels，这会显示配置项 Markdown: TOC Levels。
• 将其值设置为 2，这将限制TOC只包含到二级标题。

3.生成目录：

选择md文件，右键命令面板，选择生成目录

4.修改封面：

可以在vscode中直接编辑md，看到编辑后的结果，新增一个md文档封面

5.配置自动生成的pdf header头：

选择Markdown PDF插件==>设置==>扩展设置

默认值是

<div style="font-size: 9px; margin-left: 1cm;"> <span class='title'></span></div> <div style="font-size: 9px; margin-left: auto; margin-right: 1cm; ">%%ISO-DATE%%</div>

Markdown PDF 生成pdf文档方法

直接右键md文件进行以下操作