avichen
V2EX  ›  软件

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

  •  
  •   avichen · Aug 4, 2017 · 4381 views
    This topic created in 3211 days ago, the information mentioned may be changed or developed.

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

    7 replies    2017-08-04 20:12:17 +08:00
    superliwei
        1
    superliwei  
       Aug 4, 2017 via iPhone
    postman
    Rice
        2
    Rice  
       Aug 4, 2017 via iPhone
    swagger
    lsyAndroid
        3
    lsyAndroid  
       Aug 4, 2017 via Android
    小妖姬不错,在线的
    NealCCC
        4
    NealCCC  
       Aug 4, 2017
    @lsyAndroid 大哥,名字打对啊 是 小幺鸡,,,我搜了半天小妖姬还挺纳闷的,直到在码云上看到小幺鸡的开源项目,才反应过来
    lsyAndroid
        5
    lsyAndroid  
       Aug 4, 2017 via Android
    @NealCCC 对不住了兄弟,我在厕所里打的
    avichen
        6
    avichen  
    OP
       Aug 4, 2017
    @superliwei #1 谢谢,Postman 我一直用来测试 api 用的,我的理解是先有了 API 才用 postman,难道可以用来写 api 设计文档?
    avichen
        7
    avichen  
    OP
       Aug 4, 2017
    @Rice #2 这个我去研究一下,我一直都是整合在 springboot 中,在代码里面输出 API 文档。原来也可以用来先写 API 设计文档。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   3053 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 33ms · UTC 14:34 · PVG 22:34 · LAX 07:34 · JFK 10:34
    ♥ Do have faith in what you're doing.