写接口文档 将 api 数据添加注释后就不是 json 结构了 不能排版 注释对不齐烦躁的一逼
1
msg7086 2018-07-04 13:21:12 +08:00
所以你到底是要好的接口文档工具还是要把注释塞进 JSON 里玩呢。
|
2
yunye 2018-07-04 13:23:32 +08:00 via Android
Json 里加注释 大概是没吃饱
|
3
freestyle 2018-07-04 13:25:50 +08:00 via iPhone
这就是为什么 json 这么通用却没有流行作为配置文件格式
|
4
geelaw 2018-07-04 13:37:16 +08:00
|
6
FanWall 2018-07-04 13:48:47 +08:00 via Android
非要这样的话,试试当成 js 写?然后用的地方调用 JSON.minify 一下就是 JSON 了
http://www.javascriptoo.com/JSON-minify |
7
SuperMild 2018-07-04 14:09:44 +08:00
如果是写文档,大可以当作一个 js 的 object 来处理,这样排版就没问题了。真正使用的时候 JSON 没有注释是个正确的设计。
|
8
liuzhaowei55 2018-07-04 14:17:06 +08:00
JSON 没有一个比较好的添加注释的方法。
如果是是为了在接口文档中解释每个 Response 字段的意义,可以再添加一个字典,同样采用 JSON 结构,和 Response 保持一致,但是后边的 value 填写每个字段的解释。 |
9
baiyi 2018-07-04 15:12:55 +08:00
|
10
shsf4 2018-09-30 00:30:58 +08:00
json5
|