码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • 花了大半天,写了个springdoc/springfox/swagger文档转word的工具


    背景

    领导让我们把项目中的上百个接口用word写一个接口文档,每个项目都用了swagger,只是有的是swagger2.0的有的是swagger3.0的。

    说给我1天的时间,给我分了几十个,让手动写一天。我很好奇说这个不能直接把swagger地址丢给对方吗,或者用公司统一的接口管理平台EOLINKER,领导表示不行,说调用方是外部用户直接给swagger行不通,eolinker的话也没有时间录入了,现在只能手写。

    没办法后就只能手写了。我写了几个后表示这波操作确实难受。

    难受的原因主要是:首先没有啥技术含量,且浪费大量的时间,让找个小学初中生都可以搞定这事。操作过程就是ctrl+c/v,再调调样式,写完后再一个一个地核对,几百个接口时还要好几个同事一起来干这事着实感觉没必要。

    开源项目swagger2word

    想到既然项目中都用到了swagger,何不直接解析swagger的api的json文件就可以了。想到这里就在网上搜了下,果真找到了一个开源项目:swagger2word。
    clone下来这个项目后觉得原作者确实牛逼,想法很不错也进行了对应的实现。不过拿过来用时感觉还是有2个小主要问题:

    • 不支持3.0版本的api参数解析
    • 缺少仅筛选某个项目中部分接口文档的功能

    网上也有一个支持3.0版本的,不过没有开源,仅有在线版。地址为:swagger转word文档。

    正因为没有源码,如果需要对word界面进行调整就不方便了。大致看了下原项目的源码也还算不复杂,所以我决定自己做一版并进行开源,支持3.0版本api格式的同时还支持excel导入的方式仅导出指定的api。

    扩展版开源项目swagger2word

    用了一下午的时间完成了上面2个功能开发,并支持了docker独立部署功能。在这里给大家分享一下:

    源码地址为:
    https://github.com/puhaiyang/swagger2word

    主要用了策略模式将3.0的解析代码进行了一个处理,如果后续有其他版本的swagger接口协议又需要解析时,就可以直接在上面扩展了。

    excel导入方式预览:
    导入测试excel

    项目对应的swagger界面预览:
    1.5.2预览

    excel方式的导出结果预览:
    下载
    导出word文档预览
    word效果

    详细使用说明见源码README文件
    源码地址为:
    https://github.com/puhaiyang/swagger2word

    github_readme

  • 相关阅读:
    理解傅里叶变换
    Verifiable Secret Sharing
    19.混合使用选项和组合API需要注意哪些
    使用js的forEach时,如果想退出循环
    01-初识HTML
    基础课9——自然语言理解
    【每日一题】打卡 42
    【WSN布局】基于LICHTENBERG算的多目标传感器选择和放置优化问题研究附matlab代码
    Axure 9 使用 font awesome 字体发布原型
    R语言ggplot2可视化时间序列数据(默认时间中断部分前后自动连接起来)、创建时间分组、使用分面图(faceting)可视化时间序列数据
  • 原文地址:https://blog.csdn.net/puhaiyang/article/details/126468039
  • 最新文章
  • 【JVM】编译执行与解释执行的区别是什么?JVM 使用哪种方式?
    用 Hashids 优雅解决 C 端自增 ID 暴露问题
    V8引擎 精品漫游指南--Ignition篇(上) 指令 栈帧 槽位 调用约定 内存布局 基础内容
    LLVM Pass快速入门(四):代码插桩
    milkup:桌面端 markdown AI续写和即时渲染
    基于项目工程构建SBOM(软件物料清单)的研究
    鸿蒙应用开发UI基础第二节:鸿蒙应用程序框架核心解析与实操
    .NET 中如何快速实现 List 集合去重?
    扣子Coze实战:从0到1打造抖音+小红书热点监控智能体
    浅谈数据访问层
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
小工具 小游戏
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1

京公网安备 11010502049817号