Apideploy 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
Apideploy 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
Apideploy 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache
开发语言 Java 查看源码 »
操作系统 跨平台
软件类型 开源软件
所属分类 企业应用文档管理
开源组织
地区 国产
投 递 者 kalman03
适用人群 未知
收录时间 2023-12-29

软件简介

Apideploy 是一款 API 文档管理工具。

设计理念

Apideploy遵从以下设计理念:

  • 代码即文档。API文档应该通过代码自动生成,并能保持与代码的同步性,而不是通过手写文档来与前端、测试等进行协作;
  • 主流标准友好。文档应该支持主流的OpenAPI 2(OAS2.0)、OpenAPI 3(OAS3.0)等协议标准,同时需要支持HTTP、WebSocket、SSE等协议;
  • 版本可追溯。每一次的版本迭代,可以快速查阅接口变更的明细,支持不同版本的差异对比,并能支持回滚文档版本;
  • 接口可mock。可以直接在该产品上完成接口的测试、联调甚至接口自动化;
  • 界面要精美。友好的用户界面与交互;
  • 第三方兼容。支持导入常见的API协议标准文档,也支持导出常用的文档格式。

产品架构

en_intro

Apideploy核心分为两部分:API文档生成SDK+API托管与调试平台

API文档生成SDK是完全开放源码的,访问https://github.com/apideploy-team 可以查阅。目前仅支持Java语言实现,其他语言社区用户可以贡献,或自行直接通过API托管与调试平台的RESTFull API进行对接。Java语言SDK实现基于javadoc注释方式自动生成API文档(无代码侵入方式),也兼容了基于swagger的实现。具体使用请参考:

API托管与调试平台主要功能包括:项目管理、团队协作、权限管理、API文档托管、文档调试、接口数据mock、版本更新记录、版本对比、个性化文档导出、多格式文档导入等,是一个集API全生命周期管理的平台,非常适合团队协作。目前支持公有云与私有化部署www.apideploy.com是公有云的解决方案。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击引领话题📣 发布并加入讨论🔥
发表了资讯
2023/12/28 23:13

Apideploy 重磅开源,在成熟 API 文档解决方案中又多了一个搅局者

背景 当前,在很多中、小型的开发团队或创业团队中,依然用着落后的方式进行着API接口的交互,他们写完文档来写代码,或者,写完代码来补文档,更甚者,文档全靠一张嘴,接口描述信息在IM中沟通飞扬,在联调的过程中前后端相互扯皮、苦不堪言。 当然,也有很多优秀的团队,在使用较成熟的解决方案,诸如:swagger、springfox、springdoc、knife4j、apifox、eolink、smart-doc等等。作者基于自己多年的研发经验,参考和对比了诸如...

0
4
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
0 评论
5 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部