swagger-ui 转换成文档
最近在用swagger写API手册,写一堆注解后,启动Java工程,API文档就自动生成了,打开swagger-ui.html,效果是这样的。上面可以执行RestAPI,但是用来阅读,非常不得劲。
因为,我们想要下面这样的,哪里不会点哪里。
怎么得到这种效果呢?swagger2markup + AsciiDoc可以帮你达成目标。
Swagger2markup
swagger2markup是一个Java库,用来将Swagger自动生成的文档转换成几种流行的格式以便于静态部署和使用,比如:AsciiDoc、Markdown。但是这种方式进行swagger to markup的转换要编码初始化,做一堆事情,侵入性较大。
swagger2markup-cli 是一种将 swagger json文件转换为 Markdown 或 AsciiDoc 的命令行工具。不需要写代码,就可以进行转换。
我更喜欢swagger2markup-cli这种侵入性小的转换方式,它的主要操作步骤如下
下载swagger2markup-cli到本地(本地已安装jre)
去github https://github.com/Swagger2Ma... , 下载最新代码,编译一个jar包即可。
默认的swagger2markup-cli生成英文的AsciiDoc文档,如果要生成中文markdown文档,需要将语言设置为中文,将文档格式设置为Markdown。 配置如下,建议将这些配置保存到文档config.properties中。swagger2markup.markupLanguage=MARKDOWN swagger2markup.outputLanguage=ZH
- 获取swagger-json文件的路径
采用swagger 注解的Spring Boot工程启动后,就可以从 URL "base路径"/v2/api-docs接口可以获得 swagger-json文件 - 执行命令 swagger2markup-cli 生成markdown
java -jar swagger2markup-cli-1.3.3.jar convert -i http://127.0.0.1:8090/api/v1/v2/api-docs -c ./config.properties -f lsm
-i 指定swagger json文件可以是url地址
-c 指定配置文件
-f 指定目标文件地址,注意不需要带后缀
执行命令后你就可以得到markdown文件或AsciiDoc文件,但markdown显示后的效果是这样的,并没有我们期待的侧边栏。
AsciiDoctor
Asciidoc 是一种文档写作语言,可以展示出比markdown更好的格式效果。确实如此,我本来想先生成markdown再将markdown格式化,但搜索了半天,没有好但方案。于是我就选用了AsciiDoc,AsciiDoc有比较好但工具软件AsciiDoctor。基于这个工具可以简单快捷但生成类JavaDoc html文件,并且显示效果更好。
- 安装
Asciidoctor 使用ruby写的,我安装是使用gem安装的,gem install Asciidoctor即可。其他环境安装方法请到Asciidoctor官网查询。https://asciidoctor.org/docs/... - 转换
执行如下命令,即可得到 lsm.html,显示效果如下图
asciidoctor -d book -a toc=left -a sectnums lsm.adoc
-d 生成文件类型
-a toc=left 指定目录到左侧
-a sectnums 指定生成的文件带section编
至此搞定收工,希望你也能拥有一个满意的API 文档。
swagger-ui 转换成文档相关推荐
- 图片上的文字怎么转换成文档?三个简单的方法
因为拍照的方便或者对重要内容进行截图,不用我们一个字一个字的记录下来,这样白白浪费我们的时间.但有时难免会碰到一些内容需要我们记录下来的,想要在短时间内整理成文档之类,就需要借助一些能快速识别文字的小 ...
- 图片上的手写文字怎样才能转换成文档文字?
不知道大家有没有曾遇到过将手写的图片内容转化成文字的情况,那么大家都是怎样操作的呢?不会和小编一样将图片上的文字一点一点的敲打成文档文字的吧!其实生活中是有简单的方法的,今天小编就将这个简单的操作方法 ...
- gin 生成api文档_golang gin框架 集成swagger 自动生成文档
goswagger github仓库html https://github.com/swaggo/swag 安装 swag cligit 1.由于网络缘由,先安装gopm 管理工具github go ...
- 语音文件转换成文档(基于阿里云服务)
/** ** 作用:语音文件转换成文本 ** 注释:1.转换方式采用轮询 2.需要添加定时任务 */ require_once FCPATH.'/vendor/autoload.php'; use ...
- swagger ui 怎么输入对象_Swagger UI 传入对象类型参数
Swagger要传送对象作为参数,只需添加@ModelAttribute或@RequestBody @RestController @RequestMapping("/api/json/re ...
- 使用Swagger UI的Document和Test API
目录 介绍 配置 可视化 测试 支持属性 支持XML文档 资源/材料/参考资料 介绍 开发人员通常通过浏览器请求或使用POSTMAN, Advanced Rest Client(ARC)等客户端来测 ...
- 图片的手写文字如何识别?三招教你手写文字识别成文档
开学了,大大小小的考试将至.很多小伙伴复习的头晕脑胀的吧,特别是文科生,每天都要对着很多内容进行背诵,还得复习自己的笔记,但是记得比较匆忙随意就容易找不到重点去进行复习.这个时候就可以把笔记转换成文档 ...
- semantic ui中文文档_求你别再用swagger了,给你推荐几个在线文档生成神器
开局先推荐: Java面试刷题网站www.javazhiyin.com 前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在 ...
- spring boot rest接口自动生成文档(包含swagger)
spring boot rest接口自动生成文档(包含swagger) 写接口免不了写接口文档,但是当文档与代码分开独立演进的时候,会发生很多不同步的问题. 接口描述与代码同 ...
最新文章
- WebClient.UploadValues Post中文乱码的解决方法
- 关于Android这个名字。。。
- Java awt Desktop 无法调用系统浏览器
- k8s 关键字以及管理流程。
- proftpd的安装配置实例
- 【MVC模式】Front前端控制器模式、Jsp Model1 和 Jsp Model2、MVC思想
- 清华北大毕业生都进体制内了?
- SAP CRM WebClient UI的搜索条件是怎么渲染出来的
- loadrunner发送json_Loadrunner接口测试-发送JSON格式的请求
- Python自带又好用的代码调试工具Pdb学习笔记
- 要么出色,要么出局!威马公布三大核心技术矩阵背后的大野心
- Winform控件开发(4)——Textbox(史上最全)
- java twaver_《TWaver Java开发手册》.pdf
- BigBlueButton 2.2安装指南
- 理论小知识:字符串mset命令
- android hci设备,Android Bluetooth hci 命令分析
- 君莫笑系列视频学习(2)
- php年龄计算器,js+html实现周岁年龄计算器
- linu离线安装java1.8
- 9.16日常学习笔记
热门文章
- 鸿蒙战略看点,鸿蒙OS四大看点详解!华为的雄心不止手机,而是“一统江湖”...
- 一起来学习一款PS拓展插件——“切图神器” (CutAndSliceMe)
- click与dblclick事件冲突解决方法
- 名家语录(持续更新)
- 浏览器怎样更新java,Eclipse中js文件修改后浏览器不能及时更新的解决办法
- 在PLC控制器CPU多核的基本概念
- matlab中矩阵点乘和乘的区别(超级简单)
- 找到一个数组中每一个元素第一个比它大的元素
- 【图像处理】OpenCV中的边缘检测
- 催收评分卡(三)迁徙率模型