V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
redam
V2EX  ›  问与答

你们用什么写接口文档啊,我快被同事逼疯了

  •  
  •   redam · 2019-10-30 17:35:31 +08:00 · 5557 次点击
    这是一个创建于 1849 天前的主题,其中的信息可能已经有所发展或是发生改变。
    他是这么写的
    data: {
    private ProductInfoVo productInfo
    ...
    }

    ProductInfoVo 对象:
    {
    private SalesInfo saleInfo
    ...
    }

    SalesInfo 对象:
    {
    ...
    }


    然后这样一层层写下去,我看得要疯了
    23 条回复    2019-10-31 16:04:48 +08:00
    sunjiayao
        1
    sunjiayao  
       2019-10-30 17:47:08 +08:00
    没看明白。。 直接 copy 实体到接口文档? 我一般用 apidoc
    Vegetable
        2
    Vegetable  
       2019-10-30 17:49:00 +08:00
    啥玩意?代码当文档吗?能打过吗?
    yeah2569
        3
    yeah2569  
       2019-10-30 17:50:08 +08:00
    不是一般用 markdown 么
    redam
        4
    redam  
    OP
       2019-10-30 17:55:41 +08:00
    @sunjiayao 前公司用小幺鸡,很舒服,现在有点难受
    redam
        5
    redam  
    OP
       2019-10-30 17:56:39 +08:00
    @Vegetable 啊,估计打不过→→,就吐槽一下,顺便问你们用什么写,商量一下看能不能改
    kkkkkrua
        6
    kkkkkrua  
       2019-10-30 18:00:31 +08:00
    如果你是前端,让他给个响应 json 接口,后面加 //注释,不就好了。。
    5yyy
        7
    5yyy  
       2019-10-30 18:07:37 +08:00   ❤️ 1
    swagger
    balabalaguguji
        8
    balabalaguguji  
       2019-10-30 18:42:28 +08:00   ❤️ 1
    文档+测试,现在市面最好用的:[https://easydoc.top]( https://easydoc.top)
    chinvo
        9
    chinvo  
       2019-10-30 18:59:23 +08:00   ❤️ 1
    swagger 请
    Leigg
        10
    Leigg  
       2019-10-30 19:13:03 +08:00 via Android
    @balabalaguguji 8 楼加一,超过三人每月五块
    cluulzz
        11
    cluulzz  
       2019-10-30 22:24:59 +08:00 via iPhone   ❤️ 1
    swagger+1
    Jacky23333
        12
    Jacky23333  
       2019-10-30 23:41:24 +08:00 via Android
    yapi
    zhuwd
        13
    zhuwd  
       2019-10-31 06:12:08 +08:00 via iPhone
    yapi
    letu86
        14
    letu86  
       2019-10-31 08:52:27 +08:00   ❤️ 1
    swagger 谁用谁知道
    ebingtel
        15
    ebingtel  
       2019-10-31 08:58:07 +08:00   ❤️ 1
    换成 swagger 了
    myon
        16
    myon  
       2019-10-31 09:17:20 +08:00
    yapi
    spring3shine
        17
    spring3shine  
       2019-10-31 09:26:31 +08:00   ❤️ 1
    swagger rap2
    ibugeek
        18
    ibugeek  
       2019-10-31 09:35:53 +08:00
    eolinker,另外口口相传。
    Tecrafter
        19
    Tecrafter  
       2019-10-31 09:39:49 +08:00
    接口文档没人用 ShowDoc 吗?
    energetic
        20
    energetic  
       2019-10-31 09:52:00 +08:00
    ShowDoc +1
    icelzh
        21
    icelzh  
       2019-10-31 10:29:14 +08:00
    aglio
    Akkuman
        22
    Akkuman  
       2019-10-31 10:29:41 +08:00
    zsy979
        23
    zsy979  
       2019-10-31 16:04:48 +08:00
    ShowDoc 定义好模版还是很舒服的~
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1020 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 19:57 · PVG 03:57 · LAX 11:57 · JFK 14:57
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.