前言

若依(ruoyi)： v4.3

若依自带了 swagger 的接口。
将若依启动后，访问 http://localhost/swagger-ui.html （或者使用菜单系统工具 -> 系统接口）可以查看接口。

将若依启动后，访问 http://localhost/v2/api-docs 可以查看 json 格式的接口文档。

一切都很不错，只是要有个 html 或 pdf 格式的接口文档就更好了。

更好的 html 或 pdf 格式的接口文档

要生成更好的 html 或 pdf 格式的接口文档需要用到 swagger2pdf 项目。

生成的步骤是这样的：

将 http://localhost/v2/api-docs 的json格式接口文档，利用 Swagger2Markup Maven插件生成 asciidoc 格式的文档。
利用asciidoctor Maven插件生成 html 和 pdf 文件。

操作

克隆项目 https://gitee.com/sayyy/swagger2pdf
将 http://localhost/v2/api-docs 另存为 swagger.json
替换 swagger2pdf/src/test/resources 目录下的 swagger.json
在 swagger2pdf 目录下执行命令：
```
mvn clean test
```
在swagger2pdf/target/asciidoc目录找到 html/pdf 格式的接口文档

结果展示

参考

https://github.com/Swagger2Markup/spring-swagger2markup-demo
https://leongfeng.github.io/2017/02/20/springboot-springfox-swagger2markup-spring-restdoc/

https://gitee.com/nitianziluli/swagger2pdf
https://github.com/nitianziluli/swagger2pdf
https://blog.csdn.net/u013719669/article/details/80998225

【若依(ruoyi)】swagger 生成接口文档相关推荐

实体类接口_spring-boot-route（五）整合Swagger生成接口文档
目前,大多数公司都采用了前后端分离的开发模式,为了解决前后端人员的沟通问题,后端人员在开发接口的时候会选择使用swagger2来生成对应的接口文档,swagger2提供了强大的页面调试功能,这样可以有 ...
[Golang梦工厂]一个小项目带你学会GIN框架、JWT鉴权、swagger生成接口文档，看这一篇就够了
前言哈喽,大家好,我是asong,这是我的第八篇原创文章.听说你们还不会jwt.swagger,所以我带来一个入门级别的小项目.实现用户登陆.修改密码的操作.使用GIN(后台回复Golang梦工厂: ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
还在用Swagger生成接口文档？我推荐你试试它.....
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 JApiDocs是一个无需额外注解.开箱即用的SpringBoot ...
idea swagger生成接口文档_spring boot集成Swagger-UI接口文档
本文介绍如何用spring boot集成Swagger-UI,实现项目在线接口文档一.Swagger-UI简介 Swagger是一个Restful风格接口的文档在线自动生成和测试的框架官网对Swa ...
springboot 中文文档_还在用 Swagger生成接口文档？我推荐你试试它
JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后 ...
Swagger生成接口文档
目录 1 简单介绍 2 入门案例 2.1 引入依赖 2.2 编写配置 2.3 启动测试 3 常用注解 4 生成可以生成文档的增强 4.1 添加依赖 4.2 重启项目 5 记录生产环境的坑 6 生成do ...
SpringBoot 整合Smart-doc生成接口文档
之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger,以及如何对Swagger进行扩展让其支持接口参数分组功能.详情可见:SpringBoot 如何生成接口文档,老鸟 ...
drf 安装_drf 生成接口文档
REST framework可以自动帮助我们生成接口文档.接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 一.安装依赖 REST framewrok生成接口文档 ...

【若依(ruoyi)】swagger 生成接口文档

前言

更好的 html 或 pdf 格式的接口文档

操作

结果展示

参考

【若依(ruoyi)】swagger 生成接口文档相关推荐

最新文章

热门文章