接口文档Swagger、knife4j和YApi、APIDOC

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

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

knife4j 部署
https://blog.csdn.net/hanghangaidoudou/article/details/104924914
接口文档Swagger、knife4j和YApi、APIDOC_第1张图片

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

官方文档
https://hellosean1025.github.io/yapi/documents/index.html
接口文档Swagger、knife4j和YApi、APIDOC_第2张图片

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

你可能感兴趣的:(架构设计,接口文档,YApi,APIDOC)