重来,在成熟的方案中再造一个 API 文档解决方案的轮子: Apideploy

查看 44|回复 2
作者:kalman03   
前面发了一篇事实,被骂惨了,重新发布下。
背景
当前,在很多中、小型的开发团队或创业团队中,依然用着落后的方式进行着 API 接口的交互,他们写完文档来写代码,或者,写完代码来补文档,更甚者,文档全靠一张嘴,接口描述信息在 IM 中沟通飞扬,在联调的过程中前后端相互扯皮、苦不堪言。
作者基于自己多年的研发经验和在创业团队亲身经历,参考了国内外多个 API 管理工具和实现,始终觉得一款精美、高效的 API 平台工具,对开发者的意义重大。在苦苦找寻与对比下,各 API 管理工具依旧没有达到作者的期望,于是亲自下场,一怒之下写下了 Apideploy 。
Ad.:关于作者更多的路发冲冠之作,可以关注作者主页:https://www.kalman03.com
设计理念
Apideploy 遵从以下设计理念:
  • 代码即文档。API 文档应该通过代码自动生成,并能保持与代码的同步性,而不是通过手写文档来与前端、测试等进行协作;
  • 主流标准友好。文档应该支持主流的 OpenAPI 2 ( OAS2.0 )、OpenAPI 3 ( OAS3.0 )等协议标准,同时需要支持 HTTP 、WebSocket 、SSE 等协议;
  • 版本可追溯。每一次的版本迭代,可以快速查阅接口变更的明细,支持不同版本的差异对比,并能支持回滚文档版本;
  • 接口可 mock 。可以直接在该产品上完成接口的测试、联调甚至接口自动化;
  • 界面要精美。友好的用户界面与交互;
  • 第三方兼容。支持导入常见的 API 协议标准文档,也支持导出常用的文档格式。

    产品架构

    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是公有云的解决方案。
    API 文档与调试界面:

    一起交流加个群:

    API, 文档, apideploy, 接口

  • simo   
    大家看这里 /t/1004000
    wonderfulcxm   
    完蛋了,上篇你得罪了这里大部分技术的人,而大部分人不会选择一个讨厌的人搞的产品,除非你的产品极其出色而且没有替代品,产品怎么样我没试过,但人设已经崩塌了。
    您需要登录后才可以回帖 登录 | 立即注册

    返回顶部