V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
kalman03
V2EX  ›  分享创造

一个更好用的 API 文档解决方案

  •  1
     
  •   kalman03 · 296 天前 · 7240 次点击
    这是一个创建于 296 天前的主题,其中的信息可能已经有所发展或是发生改变。

    Apideploy是一个一站式的 API 生成、托管、调试与协同解决方案。其核心分为两部分:API 文档生成 +API 托管与调试平台。

    API 文档生成是一个自动化的过程,同时支持基于代码注释文档生成”与“基于 Swagger / OpenAPI 文档生成”, 目前提供了 Java 生成的开源代码,访问 https://github.com/apideploy-team 可以查阅。

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

    img

    img

    img

    img

    img

    有任何问题可以反馈

    19 条回复    2024-02-20 11:22:25 +08:00
    est
        1
    est  
       296 天前   ❤️ 2
    文档工具发明这么多,前后端分离是不是走了弯路。
    kalman03
        2
    kalman03  
    OP
       296 天前
    @est 你引发了我更深入的思考
    est
        3
    est  
       296 天前
    @kalman03 哈哈哈哈。
    dc2002007
        4
    dc2002007  
       295 天前   ❤️ 1
    @est 最大的弯路是把前后端的工种分开了,技术分离我是支持的,前端不懂后端,后端不懂前端,配合起来很不默契,一件完整的事情非要两个人干,前后都是 crud 的级别,却还要两个人来共同完成,这是人才的浪费,但也提供了更多的就业岗位。
    wu00
        5
    wu00  
       295 天前   ❤️ 2
    @dc2002007 不敢苟同。
    分不分也得看场景,小项目肯定是一把梭最合适。
    上了点规模的项目,不光要分前后端,甚至前后端之间还有一个中间层专门处理接口聚合、转换工作。
    就跟你写代码一样,复杂的代码肯定是要做抽离/加中间层来解耦、聚合、单一...
    本质上还是工厂流水线那一套
    dc2002007
        6
    dc2002007  
       295 天前
    @wu00 接口聚合、转换工作/抽离/加中间层来解耦、聚合、单一,这些都是工作,不是工种,如果是全栈团队的话,划分好任务,每个人都可以做到你说的流线的一部分,流水线最重要的目的是把任务划分到最小颗粒,最大程度的弱化工种的划分,我并不在乎你是否苟同我的观点!
    gbw1992
        7
    gbw1992  
       295 天前   ❤️ 1
    根据楼上说的,吐个槽
    难道前后端最完美的方案是代码生成器么
    真就是回旋镖啊
    amon
        8
    amon  
       295 天前
    同类产品有点多,眼花缭乱,
    一个个试用太麻烦,我的时间很有限,
    建议出个短视频,快速 get 到核心点,
    哦耶✌️,你就是 API 文档解决最佳方案。
    est
        9
    est  
       294 天前
    @gbw1992 文档生成到极致就是代码生成。代码生成到极致就是后端全部渲染。前端留一个 canvas 渲染就行了。。233333 。。。。
    shalk
        10
    shalk  
       282 天前
    apideploy-java-client 的作用就上传 yaml 么。。。没看到代码生成。
    另外服务端的代码不开源么,感觉和 swagger 差不多
    kalman03
        11
    kalman03  
    OP
       282 天前
    @shalk 是的,上传了 openAPI 的 json 数据。 页面展示的部分没有开源,严格来说是一个基于 openAPI 来做的更好看的 UI ,但是集成了版本管理、接口 mock 、直接 debug 测试、团队协作与权限管理等系列功能。
    BenX
        12
    BenX  
       268 天前
    貌似不是全部开源的
    kalman03
        13
    kalman03  
    OP
       263 天前
    @BenX 后台管理 UI 部分,因为并没有前后端分离,所以写的还比较“抽象”,到时整理下再放出来。
    tyzandhr
        14
    tyzandhr  
       263 天前 via Android
    @dc2002007 API 的本质是 model 的传递,所以 model 应该由专人负责,专门维护前后端的 API
    kalman03
        15
    kalman03  
    OP
       263 天前
    @tyzandhr 对外的可以这样,比如开放平台服务类性质的。但是,在业务 API 的开发过程中,这个迭代速度是非常快的,不适合专门去维护,通过持续集成( CI/CD )的方式个人感觉是一种较优雅的方案。
    jorneyr
        16
    jorneyr  
       262 天前
    前后端项目可以分离,但人不能分离,要不改个接口,设计得沟通好久。
    kalman03
        17
    kalman03  
    OP
       261 天前
    @jorneyr 是的,所以 apideploy 是一种好的选择。
    xwwsxp
        18
    xwwsxp  
       258 天前
    前后端分离最大的好处,就是在开发和部署阶段,不需要后端介入了;想想以前的 JSP 等,都是眼泪~
    forty
        19
    forty  
       256 天前
    @xwwsxp JSP 我玩过, 也一样前后端分离的.
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1684 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 20ms · UTC 16:39 · PVG 00:39 · LAX 09:39 · JFK 12:39
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.