码农知识堂 - 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

  • 相关阅读:
    C++ json-cpp库的基本使用方法
    [附源码]java毕业设计网上书店的设计
    华为云云耀云服务器L实例评测|安装Java8环境 & 配置环境变量 & spring项目部署 &【!】存在问题未解决
    Android setTheme设置透明主题无效
    libevent学习——event_base
    【Leetcode】1216. Valid Palindrome III
    软件工程学习笔记14——案例解析篇
    2023南昌航空大学考研介绍
    Hybrid app本地开发如何调用JSBridge
    Error-onnxruntime.capi.onnxruntime_pybind11_state.Fail:
  • 原文地址:https://blog.csdn.net/puhaiyang/article/details/126468039
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号