简介

doc-apis是一款真正意义上的零侵入接口文档生成工具,无需增加一行代码,无需增加一行配置,甚至都不需要把它打包进项目,只需要将相关依赖引入项目,轻点启动,即可一次性生成web,ios,android接口文档,并且支持在线调试等众多强大功能.

理念 把易用和轻量做到极致.

愿景 成为全球最受欢迎的接口文档工具.

收费 对所有个人用户以及规模小于10人的初创型公司终身免费使用,仅针对中大型企业收取少量费用,以此提供更优质的服务和确保框架活得更久.

详解 点此下载PPT,解锁更多doc-apis故事 (opens new window)

优势

• 零侵入: 不需要像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分钟光速上手
• 智能客服: 官网提供了针对doc-apis全部使用文档专项训练增强的AI答疑机器人,可辅助解决您在使用中遇到的各种问题
• 费用低廉: 个人用户及规模小于等于10人的企业终身免费使用,中大型企业按规模阶梯收取少量费用,非盈利目的,仅为可持续发展
• 持续更新: 活跃的开源社区,强大的研发团队,未来可期...

框架架构

代码托管

码云Gitee (opens new window)✔ | Github (opens new window)✔

参与贡献

doc-apis拥有行业内领先的设计理念,并且开发团队来源于Dromara开源社区及Aizuda开源社区,我们立志将其打造为全球最受欢迎的接口文档生成工具,所以在此欢迎各路好汉一起来参与完善doc-apis,我们期待您的 PR！

• 贡献代码：代码地址 doc-apis (opens new window)，欢迎提交 Issue 或者 Pull Requests
• 维护文档：文档地址 doc-apis (opens new window)，欢迎参与翻译和修订