请问大家有没有好用的 json 或者 api 文档管理工具

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 696 天前的主题，其中的信息可能已经有所发展或是发生改变。

需求：

一定要清晰，清晰，清晰。每个字段的含义可以写详细注释，json 结构不要以表格的形式展示，要以 json 文档的形式展示；
是“文档”管理，不是调试，不需要接口调试的功能；
方便信息共享，最好是像 rap2 那样支持自部署的 web 端，或者客户端工具也可以；

JSON

文档

调试

清晰

18 条回复 • 2022-12-29 20:20:59 +08:00

xuanbg

2022-12-26 21:42:08 +08:00

手写，其实一点都不麻烦。也就是模版填空加上复制 /粘贴 /修改一点点内容。

needpp

2022-12-26 21:49:55 +08:00

查看右边的广告？

wu67

2022-12-26 21:54:40 +08:00

我觉得 gitlab 的 wiki 就很好, 直接用 markdown 写, object 型数据你爱怎么写都行, 复杂数据结构还能在下面写连接跳转对应结构的 wiki, 还有历史记录

unt

2022-12-26 22:09:53 +08:00

@xuanbg #1 主要是不美观，查看起来也不是很方便

unt

2022-12-26 22:10:04 +08:00

@wu67 #3 我去看看

xuanbg

2022-12-27 03:12:34 +08:00

@wu67 咱们想的完全一样。手写 markdown 才是程序员该干的事。

inrmsYu

2022-12-27 08:20:21 +08:00

apipost ？

IMCDR2

2022-12-27 08:41:21 +08:00

yapi?

unt

2022-12-27 08:52:21 +08:00

@iamacodertoo #8 用过的，不行，文档功能不太好

@xuanbg #6 md 的话注释功能不行吧，我要给每个字段写注释，然后需要能够复制整个 json, 能实现吗

balabalaguguji

2022-12-27 09:31:03 +08:00

这个效果如何： https://easydoc.net/s/17790664/CZMqMhfW/78558034

nekoneko

2022-12-27 17:08:14 +08:00

postman 自带

garfield12

2022-12-27 17:31:54 +08:00

apifox

star7th

2022-12-27 23:00:16 +08:00

showdoc 。

github.com/star7th/showdoc

shanyue

2022-12-28 11:32:51 +08:00

Apifox 的文档 https://www.apifox.cn/apidoc/project-1608695/doc-1406337 ，看看怎么样

unt

2022-12-28 13:55:39 +08:00

@garfield12 #12
@shanyue #14 刚出来的时候就用过，ui 肯定是属于中上层没得讲，但是必须登录账号，不能自部署（要钱）加离线，🐶都不用（网络用语，非冒犯）

unt

2022-12-28 13:56:27 +08:00

@star7th #13 嗯，这些都有记录在自己的小本本上，之前用过，我再试试

hellojukay

2022-12-28 14:20:53 +08:00

openapi

8bryo4p5qn758Dmv

2022-12-29 20:20:59 +08:00

https://gotcha.rest 支持设计 API ，编辑和复用数据模型，导出到 Swagger 或 OpenAPI 格式。你需要的“每个字段的含义可以写详细注释”完全支持，并且可以编辑约束条件，默认值示例值这些