接口文档Swagger、knife4j和YApi、APIDOC

今天药忘吃喽~ 2022-11-13 06:22 226阅读 0赞

## 接口文档Swagger、knife4j和YApi、APIDOC功能对比图 ##

<table> 
 <thead> 
  <tr> 
   <th>API文档工具</th> 
   <th>简介</th> 
   <th>特点</th> 
   <th>跨语言</th> 
   <th>在线编辑</th> 
   <th>导入文档</th> 
   <th>导出离线文档</th> 
   <th>权限管理</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Swagger</td> 
   <td>spring-boot支持的基本API生成文档模块</td> 
   <td>可以导出api的json格式，强依赖Java项目运行，不支持离线文档功能</td> 
   <td>java</td> 
   <td>–</td> 
   <td>–</td> 
   <td>–</td> 
   <td>–</td> 
  </tr> 
  <tr> 
   <td>knife4j</td> 
   <td>knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案 UI和服务分离-增强UI</td> 
   <td>根据标准规范，生成的在线markdown离线文档，开发者可以进行拷贝生成markdown接口文档，通过其他第三方markdown转换工具转换成html或pdf</td> 
   <td>java</td> 
   <td>–</td> 
   <td>–</td> 
   <td>支持</td> 
   <td>–</td> 
  </tr> 
  <tr> 
   <td>YApi</td> 
   <td>独立运行的js-web项目</td> 
   <td>支持常用的接口管理功能，提供了权限管理、Mock数据、Swagger数据导入和API接口导出静态文本格式，在线接口测试和切换配置环境</td> 
   <td>所有webAPI</td> 
   <td>支持</td> 
   <td>JSON,Swagger,postman,chrome录制</td> 
   <td>html,markdown,json</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>APIDOC</td> 
   <td>一个简单的 RESTful API 文档生成工具，它从代码注释中提取特定格式的注解内容生成API文档，支持诸如 Go、Java、C++、Rust 等大部分开发语言，跨平台，linux、windows、macOS</td> 
   <td>提供IDEA和VS code插件，支持大部分开发语言，跨平台，很方便扩展；支持多个不同语言的多个项目生成一份文档；输出模板可自定义；根据文档生成 mock 数据；</td> 
   <td>跨语言跨平台</td> 
   <td>–</td> 
   <td>–</td> 
   <td>默认html</td> 
   <td>–</td> 
  </tr> 
 </tbody> 
</table>

knife4j 部署  
https://blog.csdn.net/hanghangaidoudou/article/details/104924914  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pqY2phdmE_size_16_color_FFFFFF_t_70]

YApi环境部署  
https://juejin.cn/post/6844903874046722055

官方文档  
https://hellosean1025.github.io/yapi/documents/index.html  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pqY2phdmE_size_16_color_FFFFFF_t_70 1]

apidoc官方文档  
https://apidoc.tools/

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pqY2phdmE_size_16_color_FFFFFF_t_70]: /images/20221022/d452608eb6154c0a9dba57c56319bf81.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pqY2phdmE_size_16_color_FFFFFF_t_70 1]: /images/20221022/50c15e559591448fb8eeb2fd83fb4c94.png