您的Star是我继续前进的动力，如果喜欢doc-apis请右上角帮忙点亮星星⭐!
doc-apis 官网 https://doc-apis.com/
dic-apis gitee https://gitee.com/aizuda/doc-apis
dic-apis github https://github.com/aizuda/doc-apis
aizuda 官网 https://aizuda.com/home
aizuda gitee https://gitee.com/aizuda
dromara 官网 https://dromara.org/
dromara gitee https://gitee.com/dromara/
Tip: 官网是vue单页面应用，且服务部署在🇺🇸,国内用户首次访问加载可能比较慢🐢，主公们请耐心等待一下，后续会很快🏹，如偶遇打不开可刷新多尝试几次,或尝试魔法上网.
doc-apis是一款真正意义上的零侵入接口文档生成工具,也是目前全球使用最为简单的接口文档生成工具, 无需增加一行代码,无需增加一行配置,甚至都不需要把它打包进项目,只需几秒,将maven坐标(gav)引入项目, 轻点启动,即可一次性生成web,ios,android等多端多语种国际化接口文档,并且支持在线调试等众多强大功能.
- 零侵入: 不需要像Swagger等框架,需要写额外的业务代码才能生成文档,只要代码符合规范,即可自动生成接口文档
- 零配置: Springboot项目最少仅需0行配置,即可自动生成接口文档,所有配置为易用而生,均有默认值,按需配置即可
- 依赖透明: 引入后对原项目完全透明,无任何影响,甚至都不需要打包进项目,无需担心引入三方依赖带来额外风险
- 敏捷开发: 无需实现接口,仅需要定义好接口请求URL,请求类型,请求出入参即可生成,便于前后端快速投入开发
- 内容丰富: 从请求URL,到请求方式,请求入参,出参应有尽有,参数类型,是否必填,参数描述等所需全部信息一目了然
- 类型丰富: 可一次性生成Hmtl,MD等多种格式文档,并且同时适配WEB,IOS,Android等多种类型,适应各种需求场景
- 支持广泛: 无论是主流的SpringBoot项目,Spring项目还是小众的Jfinal,Player等均可适配
- 功能强大: 支持在线调试功能,支持多种请求方式,支持自定义请求头等功能,一站式搞定接口文档及接口调试
- 多语言: 支持生成多国语言的接口文档,并且使用文档目前也已支持中英文双语,其它语种欢迎有志之士贡献
- 兼容性好: 不挑食,从JDK8-JDK21均兼容,SpringBoot从1.x-3.x均可兼容,Spring,Jfinal等项目可兼容所有版本
- 规范代码: 从源头监控代码质量,哪个模块代码未写注释,未遵循Restful风格接口设计等一目了然,反向督促开发者规范代码
- 使用简单: 高端的食材仅需简单的烹饪,高端的文档生成框架也仅需简单的操作,从入门到精通0~5分钟光速上手
- 持续更新: ...
Maven:
<dependency>
<groupId>com.doc-apis</groupId>
<artifactId>doc-apis-starter</artifactId>
<version>${Latest Version}</version>
</dependency>Gradle:
compile group: 'com.doc-apis', name: 'doc-apis-starter', version: 'Latest Version'
欢迎提出更好的意见，帮助完善 doc-apis
QQ | 微信:252645816
您的支持是鼓励我们前行的动力，无论金额多少都足够表达您这份心意。
我们的广告投放商,如果您期望doc-apis能够走得更远,不妨点击下图,支持一下我们的广告商Thanks♪(･ω･)ﾉ
