接口文档工具进度报告

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

接口文档工具调研：

  • 主要考虑文档的易用性、可读性、扩展性、是否支持私有化部署、以及部署是否方便快捷、是否收费等因素

  • 决定采用基于Yapi私有部署（公司已部署）进行功能扩展

  • yapi对于权限、项目管理、接口运行、数据mock、自动化测试、数据导入导出、二次开发（和胡挺沟通过，也能支持）都有很好的支持

    • 公司已有部署、私有化部署胡挺做过，比较熟悉，node.js开发的

    • 能做到在线实时团队共享

  • 结合群内痛点讨论，一期需求整理如下：

    1. 接口文档展示依托Yapi平台在线实时展示

    2. 业务侧以简单方便的形式实现api接口实时更新到Yapi平台

  • 代码已经跑通，bug需要修复，细节改进
                1、返回值对象没有成功写入
                2、参数没有注释的情况下写入接口路径
                3、参数备注，只需要输入格式即可
                    @param uri uri备注
                4、熟悉代码逻辑
                5、如果接口已经上传，无法自动覆盖    
                6、参数是否必须
                7、接口状态：“未完成”、“已完成”

  • 计划下周发布1.0.0版本，大家在使用中发现问题，提出改进意见

  • 近期准备拉一个会，讨论后续优化方向

    • 包括yapi一些高级的应用，需要代码实现自动化的，我这边可以继续调研开发

      • 本身这个工具我进小米前也没用过

方案一（0.1.0-SNAPSHOT）：

  • 工具以maven插件形式承载，执行插件自动上传api到yapi平台

    • pom配置

方案二（0.2.0-SNAPSHOT）：

  • Spring spi机制，伴随SpringBoot启动，自动上传api，业务侧不感知

    • 引入jar包 

      • <dependency>
           <groupId>com.xiaomi.mina.apidoc</groupId>
           <artifactId>apidoc-autoconfig</artifactId>
           <version>0.2.0-SNAPSHOT</version>
        </dependency>

    • 添加配置 

      • yapi.enabled=true   //是否启用自动上传api接口
        yapi.token=7e7976b0f85a81a7a986    //yapi项目token

以上是 接口文档工具进度报告 的全部内容， 来源链接： utcz.com/z/513248.html

回到顶部