一飞开源，介绍创意、新奇、有趣、实用的开源应用、系统、软件、硬件及技术，一个探索、发现、分享、使用与互动交流的开源技术社区平台。致力于打造活力开源社区，共建开源新生态！

一、开源项目简介

doc-apis是一款真正意义上的零侵入接口文档生成工具,也是目前全球使用最为简单的接口文档生成工具, 无需增加一行代码,无需增加一行配置,甚至都不需要把它打包进项目,只需要几秒,将maven坐标(gav)引入项目, 轻点启动,即可一次性生成web,ios,android等多端多语种国际化接口文档,并且支持在线调试等众多强大功能.

二、开源协议

使用AGPL-3.0开源协议

三、界面展示

效果 | Preview

四、功能概述

优点 | Advantages

• 零侵入: 不需要像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'

六、源码地址

源码下载