使用插件将swagger文档转html或pdf

要使用插件将Swagger文档转换为HTML或PDF,你可以使用swagger2markup工具。以下是如何将Swagger文档转换为HTML和PDF的步骤和示例代码:

  1. 首先,确保你有一个Swagger定义文件,通常是一个JSON文件,可以是URL或本地路径。
  2. 使用swagger2markup工具生成HTML或PDF。你需要下载并添加swagger2markupasciidoctor的依赖到你的项目中。

以下是Maven的pom.xml中的依赖示例:




<dependencies>
    <dependency>
        <groupId>io.github.swagger2markup</groupId>
        <artifactId>swagger2markup</artifactId>
        <version>1.3.3</version>
    </dependency>
    <dependency>
        <groupId>org.asciidoctor</groupId>
        <artifactId>asciidoctorj</artifactId>
        <version>2.4.3</version>
    </dependency>
</dependencies>
  1. 使用以下Java代码生成HTML或PDF:



import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;
 
import java.net.URL;
 
public class SwaggerToHtmlPdfExample {
    public static void main(String[] args) throws Exception {
        // 定义Swagger文档的URL
        URL swaggerUrl = new URL("http://your-swagger-definition-url/v2/api-docs");
 
        // 设置输出路径
        String outputPath = "src/docs/asciidoc/generated";
 
        // 设置配置
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.EN)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();
 
        // 转换Swagger文档到HTML
        Swagger2MarkupConverter.from(swaggerUrl)
                .withConfig(config)
                .build()
                .toFolder(outputPath);
 
        // 转换Swagger文档到PDF
        Swagger2MarkupConverter.from(swaggerUrl)
                .withConfig(config)
                .build()
                .toPDF(outputPath + "/swagger.pdf");
    }
}

确保替换http://your-swagger-definition-url/v2/api-docs为你的实际Swagger定义URL。

以上代码会生成AsciiDoc格式的文件,然后你可以使用AsciiDoc工具链将其转换为HTML或PDF。

生成HTML:




asciidoctor -r asciidoctor-diagram -a toc=left -d book src/docs/asciidoc/generated/swagger.adoc

生成PDF:




asciidoctor-pdf -r asciidoctor-diagram -d book src/docs/asciidoc/generated/swagger.adoc -o src/docs/asciidoc/generated/swagger.pdf

请确保你有AsciiDoctor和AsciiDoctor P

none
最后修改于:2024年08月10日 13:08

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日