redam
V2EX  ›  问与答

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

  •  
  •   redam · Oct 30, 2019 · 6700 views
    This topic created in 2562 days ago, the information mentioned may be changed or developed.
    他是这么写的
    data: {
    private ProductInfoVo productInfo
    ...
    }

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

    SalesInfo 对象:
    {
    ...
    }


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