寻一个开发设计文档工具，能有效管理前后端分离开发的需求设计

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2663 天前的主题，其中的信息可能已经有所发展或是发生改变。

有什么工具能够方便写出前后端分离应用的 API 设计文档，既美观，又实用，一目瞭览，层次分明，可以让前端知道调用 API 的细节，让后台开发明确 API 如何开发，包括请求参数、返回参数和业务逻辑等。写这个文档的人既懂技术又了解需求，只是为了让开发人员直接依靠这个文档就能快速去开发。

7 条回复 • 2017-08-04 20:12:17 +08:00

superliwei

2017-08-04 12:43:39 +08:00 via iPhone

postman

Rice

2017-08-04 12:50:15 +08:00 via iPhone

swagger

lsyAndroid

2017-08-04 13:19:48 +08:00 via Android

小妖姬不错，在线的

NealCCC

2017-08-04 15:49:27 +08:00

@lsyAndroid 大哥,名字打对啊是小幺鸡,,,我搜了半天小妖姬还挺纳闷的,直到在码云上看到小幺鸡的开源项目,才反应过来

lsyAndroid

2017-08-04 18:24:33 +08:00 via Android

@NealCCC 对不住了兄弟，我在厕所里打的

avichen

2017-08-04 20:10:29 +08:00

@superliwei #1 谢谢，Postman 我一直用来测试 api 用的，我的理解是先有了 API 才用 postman，难道可以用来写 api 设计文档？

avichen

2017-08-04 20:12:17 +08:00

@Rice #2 这个我去研究一下，我一直都是整合在 springboot 中，在代码里面输出 API 文档。原来也可以用来先写 API 设计文档。