yapi 调研

20200207

• 项目调研可以写一下俩工程的实现原理，最后采用哪个工程进行改造，采用的实现方案是什么
•  

20200206

• https://segmentfault.com/a/1190000021008147

早前.....

大家好，关于接口文档工具，结合前天群里的讨论，简单做了些调研，我觉得可以参考目前咱们工作实际，从短期和长期两个方向考虑，短期来讲解决当前使用中的痛点，长期来讲看看能否封装一个产品话的工具。大家有什么问题可以提出来，比如下面的是我结合群聊做的一个demo

1. springfox-swagger 的代码侵入问题
2. yapi接口录入麻烦问题
   • 可以考虑结合https://github.com/zxcvbnmzsedr/apidoc 二次开发
     • 0.1.0版本
   • 这两天我写一个Demo，做一个maven插件，结合上述代码库，将javadoc 通过yapi的 openapi的方式自动导入ypai
     • 
   • pom配置
     • 
   • 导入效果：
     • 
   • 只需要相关注释，不用写注解侵入性小
     • 对于没有注释的可兼容优化类型和方法名代替
       • 
3. 是否需要私有化部署yapi
   • 建议使用公司现有工具，不重复造轮子
   • 如果现有工具不能满足需求，或者咱们提出的问题沟通支持缓慢，再考虑私有化部署

0.2.0版本

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

  • org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.ztianzeng.apidoc.YApiAutoConfiguration

• 具体使用步骤：
  1. 引入jar包

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

  2. 参数传入

     • yapi.enabled=true
       yapi.token=7e7976b0f85a81a7a986

       
        

 

来源：oschina

链接：https://my.oschina.net/u/3847203/blog/3163379