4

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

 2 years ago
source link: https://www.v2ex.com/t/825800
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

V2EX  ›  程序员

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

  dingyaguang117 · dingyaguang117 · 17 小时 24 分钟前 · 244 次点击

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

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

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

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


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK