V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
dingyaguang117
V2EX  ›  程序员

有使用 Stoplight 做文档管理的团队吗

  •  
  •   dingyaguang117 ·
    dingyaguang117 · 2022-01-02 16:53:29 +08:00 · 940 次点击
    这是一个创建于 861 天前的主题,其中的信息可能已经有所发展或是发生改变。

    准备尝试下 Stoplight ,在初步接触中发现几个问题:

    1. OpenAPI 没有接口目录概念,只有按照 Tag 进行分组。对于复杂项目,原来可能会有二级目录,现在就不太方便迁移。

    2. 编辑器左侧是 Paths(URL)聚合的, 而渲染出来是按照 Method+URL 分开。这个我理解是局限于 OpenAPI 的数据结构定义。但是这样对于编辑和渲染会产生一种不太一致的展示表现,不方便查找。

    不知道大家有没有相同的困惑,是如何解决的呢?另外也有老项目很多接口设计不是那么 Restful 的缘故

    目前尚无回复
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3128 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 13:53 · PVG 21:53 · LAX 06:53 · JFK 09:53
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.