如何快速将 swagger 导出 PDF、markdown

最新推荐文章于 2024-04-29 17:03:38 发布
最新推荐文章于 2024-04-29 17:03:38 发布
阅读量4.5k 收藏 18
点赞数 4
分类专栏： HTTP 文章标签： swagger2 markdown 接口 xpdf api
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fei12990/article/details/120857284
版权

标题背景

我们在项目开发完成，接口写好后，需要将接口文档给到前端同学，或者合作方的工程师。但 swagger
对接口阅读并不友好，大部分情况下还得把服务启动好才能访问。

这篇文章给各位开发人员介绍如何使用 docway 将 swagger 导出 PDF 或者 markdown 。

第一步：准备 swagger json

  1. 打开 swagger ui 的页面
  2. 点击 swagger json 的链接（可能没有显示该链接）
    在这里插入图片描述
  3. 如果你的 swagger 页面没有显示该链接，F12打开开发者工具，重新刷新后，复制 api-docs 的响应内容。
    在这里插入图片描述4. 在弹出的tab页中
最低0.47元/天 解锁文章
码上有肉吃
关注
  • 4
    点赞
  • 踩
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
将Swagger2文档导出为HTML或markdown等格式离线阅读解析
08-25
主要介绍了将Swagger2文档导出为HTML或markdown等格式离线阅读，本文给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
Swagger导出离线文档 接口文档
weixin_44339617的博客
08-20 6705
Swagger导出离线文档，导出接口文档，类型：DOC、PDF、MARKDOWN
Swagger导出接口文档（简单版）
最新发布
weixin_52270065的博客
04-29 789
之后运行项目访问http://localhost:项目端口号/swagger-ui.html。可以任选则以上的框复制里边的json数据，然后打开网站。，将json数据粘贴生成即可。
不下载任何插件和依赖，在线导出swagger的api接口文档（word）
2301_78149288的博客
02-02 6954
不需要任何依赖和插件，swagger生成的api文档开始导出word
swagger-gendoc:swagger文件（yaml、json）转换为pdf、html、epub3、docbook等
04-27
项目简介 本项目主要演示了将swagger-editor编辑好的swagger.yaml或swagger.json,转换为asciidoc,继而转换成其他各种格式,如:HTML、PDF、EPUB3、DOCBOOK等 主要用到了两个maven插件: swagger2markup-maven-plugin asciidoctor-maven-plugin 如何使用 将swagger.yaml或swagger.json文件放入src/test/resources包.若是swagger.json格式的话需要修改pom.xml中定义的<swagger>属性。 mvn test 因为用到的两个插件不会自动执行,所以指定了插件执行所在的阶段为test,故maven插件目标包含test环节的命令都可以执行。执行完毕后,将在target/asciidoc下会看到生成的文档。 注意事项 若你设计的
swagger导出到pdf、html文档
北回归线的博客
01-27 1万+
swagger导出pdf, work, html接口文档
java中如何使用Swagger导出本地
weixin_67239318的博客
03-06 1521
java使用Swagger导出本地
Swagger导出word和excel文档
热门推荐
xunming的专栏
03-31 1万+
参考博文 1、Swagger文档转Word 文档 2、提取swagger内容到csv表格，excel可打开
swagger导出接口文档
ડUN的博客
01-10 4043
pom依赖 <!-- swagger导出PDF/HTML所需依赖 --> <dependency> <groupId>io.github.swagger2markup</groupId> <artifactId>swagger2markup</artifactId> <version>1.3.1</version> </dependency> pom插件依赖 swagger2markup
【Tools】如何通过swagger导出离线接口文档
whereabouts_的博客
11-11 4525
如何通过swagger导出离线接口文档
swagger导出pdf和html
11-14
下面将详细介绍如何使用 Swagger 导出 PDF 和 HTML。 Swagger 导出配置 为了将 Swagger 导出 PDF 和 HTML，需要在 Maven 项目中添加相应的配置。首先，需要在 `pom.xml` 文件中添加以下属性： ```xml ...
markdown-swagger：将Swagger文件中的API文档生成为markdown文件
02-04
将Swagger文件中的API文档生成为markdown文件。 安装 npm install markdown-swagger 用法 markdown-swagger ./api/swagger/swagger.yaml ./README.md 这将读取指定的swagger文件并生成一个表，该表描述目标markdown...
swagger-markdown：摇摇欲坠的markdown转换器
02-04
CLI脚本可将swagger yaml转换为markdown文件。 仅支持swagger 2.0格式 查看文件夹 安装 npm install -g swagger-markdown 用法 swagger-markdown [-h] [-v] -i [-o] [--skip-info] Options: -h, --help Show this ...
Gradle环境下导出Swagger为PDF的步骤详解
08-25
Gradle环境下导出Swagger为PDF是一种常见的需求，特别是在需要将接口文档交付给他人或进行存档时。 Swagger是一种流行的接口文档生成工具，而Gradle则是Java项目的常用构建工具。下面我们将详细介绍如何在Gradle环境...
Swagger接口文档的导出使用
lybnmd的博客
02-10 5154
Swagger接口文档的导出使用
Swagger2使用及导出api文档
yanzanjie2018的博客
05-10 3239
swagger2依赖、导出接口文档 <!--Swagger-UI API文档生产工具--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version>
Swagger导出接口文档（apifox）
linger04的博客
09-12 2421
首先启动项目，访问Swagger地址：ip+端口+路径+swagger-ui.html。把地址输入然后点击提交即可导入接口道apifox，然后点击导出。复制这个链接，打开apifox。即可按需导出自己需要的格式。
如何把swagger项目导出成json或者yaml文件
ff1834453983的博客
09-25 3764
2.按F12，查看网络，先择Fetch/XHR,根据swagger版本的不同，文件也可能不同，一般情况是：v1、swagger.json，swagger.yaml，api-docs等等类似文件。1.先进去swagger/UI界面，然后看下左下角的BASE URL有没有完整连接，如果有直接访问就行。json或者swagger.yaml文件即可。3.提取到返回的json数据后，进入。网页，在线生成对应的swagger.

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值