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

有没有在 json 里添加注释的工具

  •  
  •   zhazi · 2018-07-04 11:35:09 +08:00 via Android · 3199 次点击
    这是一个创建于 2369 天前的主题,其中的信息可能已经有所发展或是发生改变。

    写接口文档 将 api 数据添加注释后就不是 json 结构了 不能排版 注释对不齐烦躁的一逼

    10 条回复    2018-09-30 00:30:58 +08:00
    msg7086
        1
    msg7086  
       2018-07-04 13:21:12 +08:00
    所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。
    yunye
        2
    yunye  
       2018-07-04 13:23:32 +08:00 via Android
    Json 里加注释 大概是没吃饱
    freestyle
        3
    freestyle  
       2018-07-04 13:25:50 +08:00 via iPhone
    这就是为什么 json 这么通用却没有流行作为配置文件格式
    geelaw
        4
    geelaw  
       2018-07-04 13:37:16 +08:00
    一个可能的方式是宽松化你的 schema。

    {
    "@comment": "这是一段注释",
    "username": "example",
    "email": "[email protected]"
    }
    geelaw
        5
    geelaw  
       2018-07-04 13:37:59 +08:00
    @geelaw C 系程序员了,没有分号才对
    FanWall
        6
    FanWall  
       2018-07-04 13:48:47 +08:00 via Android
    非要这样的话,试试当成 js 写?然后用的地方调用 JSON.minify 一下就是 JSON 了
    http://www.javascriptoo.com/JSON-minify
    SuperMild
        7
    SuperMild  
       2018-07-04 14:09:44 +08:00
    如果是写文档,大可以当作一个 js 的 object 来处理,这样排版就没问题了。真正使用的时候 JSON 没有注释是个正确的设计。
    liuzhaowei55
        8
    liuzhaowei55  
       2018-07-04 14:17:06 +08:00
    JSON 没有一个比较好的添加注释的方法。
    如果是是为了在接口文档中解释每个 Response 字段的意义,可以再添加一个字典,同样采用 JSON 结构,和 Response 保持一致,但是后边的 value 填写每个字段的解释。
    baiyi
        9
    baiyi  
       2018-07-04 15:12:55 +08:00
    JSON Schema

    http://json-schema.org/

    可以了解下合不合适
    shsf4
        10
    shsf4  
       2018-09-30 00:30:58 +08:00
    json5
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2583 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 04:57 · PVG 12:57 · LAX 20:57 · JFK 23:57
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.