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

2017-08-04 10:47:42 +08:00
 avichen

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

3520 次点击
所在节点    软件
7 条回复
superliwei
2017-08-04 12:43:39 +08:00
postman
Rice
2017-08-04 12:50:15 +08:00
swagger
lsyAndroid
2017-08-04 13:19:48 +08:00
小妖姬不错，在线的
NealCCC
2017-08-04 15:49:27 +08:00
@lsyAndroid 大哥,名字打对啊 是 小幺鸡,,,我搜了半天小妖姬还挺纳闷的,直到在码云上看到小幺鸡的开源项目,才反应过来
lsyAndroid
2017-08-04 18:24:33 +08:00
@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 设计文档。

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/380347

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX