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

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

  •  
  •   redam · 89 天前 · 2585 次点击
    这是一个创建于 89 天前的主题,其中的信息可能已经有所发展或是发生改变。
    他是这么写的
    data: {
    private ProductInfoVo productInfo
    ...
    }

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

    SalesInfo 对象:
    {
    ...
    }


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