40°

接口文档工具分享

接口文档工具分享:

  1. 工具的使用
    • 两种工具使用方式
    • mock的支持
  2. 工具的原理
    • 启动与清理
      • maven插件(不绑定任何maven阶段)
        • maven-invoker 在root pom执行
        • clean  install -Dmaven.test.skip=true
        • 然后对各个子module进行扫描,对包含controller的类进行接口上传
        • 清理不属于该项目的接口和分类
      • spring spi机制
        • 启动项目
        • 扫描项目下的controller的类,进行接口上传
        • 清理不属于该启动项目的接口和分类
    • 实现细节:
      • 参考了志辉和志敏提供的项目,基于志敏提供的项目二次开发
        • 原先项目解析controller封装openapi3.0  json
          • json上传yapi后发现很多返回结果和参数展示存在问题
          • 后续还发现json解析也存在一些问题
          • 仅支持import_data 接口
            • 该接口只支持新增和更新,也就是说上传完后还是需要人工操作的
      • 解析细节
        • 使用qdox jar包,javadoc也是使用的该jar 包
          • 源码解析
        • 同时也大面积使用反射
          • 个人觉得这俩使用一个即可
          • 仅仅使用源码解析的话兼容性会更加的好
      • 调取 yapi开放接口实现上传
        • 由于yapi接口以及json格式版本变化比较大,出现各种不适配情况
        • 我采用了相对简单粗暴的方法
          • yapi平台,F12,进行各种操作后,查看接口参数和返回结果,以此为依据进行封装
      • 开发难点,相当一部分时间花在解析纠错和解析扩展上

本文由【Java搬砖工程师】发布于开源中国,原文链接:https://my.oschina.net/u/3847203/blog/3196698

全部评论: 0

    我有话说: