寻一个开发设计文档工具,能有效管理前后端分离开发的需求设计 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
avichen
V2EX    软件

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

  •  
  •   avichen 2017 年 8 月 4 日 4298 次点击
    这是一个创建于 3158 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    7 条回复    2017-08-04 20:12:17 +08:00
    superliwei
        1
    superliwei  
       2017 年 8 月 4 日 via iPhone
    postman
    Rice
        2
    Rice  
       2017 年 8 月 4 日 via iPhone
    swagger
    lsyAndroid
        3
    lsyAndroid  
       2017 年 8 月 4 日 via Android
    小妖姬不错,在线的
    NealCCC
        4
    NealCCC  
       2017 年 8 月 4 日
    @lsyAndroid 大哥,名字打对啊 是 小幺鸡,,,我搜了半天小妖姬还挺纳闷的,直到在码云上看到小幺鸡的开源项目,才反应过来
    lsyAndroid
        5
    lsyAndroid  
       2017 年 8 月 4 日 via Android
    @NealCCC 对不住了兄弟,我在厕所里打的
    avichen
        6
    avichen  
    OP
       2017 年 8 月 4 日
    @superliwei #1 谢谢,Postman 我一直用来测试 api 用的,我的理解是先有了 API 才用 postman,难道可以用来写 api 设计文档?
    avichen
        7
    avichen  
    OP
       2017 年 8 月 4 日
    @Rice #2 这个我去研究一下,我一直都是整合在 springboot 中,在代码里面输出 API 文档。原来也可以用来先写 API 设文档。
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2590 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 23ms UTC 01:42 PVG 09:42 LAX 18:42 JFK 21:42
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86