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

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

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

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

    SalesInfo 对象:
    {
    ...
    }


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