json接口文档编写工具_另一个Json文档工具

json接口文档编写工具

There are many JSON structure documentation tool, I have build one more for my office work .https://jsondoc.online

有很多JSON结构文档工具，我还为我的办公室工作构建了一个。 https://jsondoc.online

For me i can classify them in :

对我来说，我可以将它们分类为：

1.典范装饰工具 (1. Code decorative tools)

Tools that require to add an annotation in code and then tools generate documentation out it For eg: swagger

需要在代码中添加注释，然后工具生成注释的工具，例如：swagger

2. 声明工具 (2. Declarative tools)

Tools that require to fill text in a particular schema, then tools parse it and generate documentation view. For eg: Json Schema specification

需要在特定模式中填充文本，然后对其进行解析并生成文档视图的工具。 例如：Json Schema规范

为什么要创建另一个工具？ (Why create another tool?)

Existing tools requires a strong/clear understanding of what Json represents ORIt assumes that all team member/teams understand the schema to define/edit it.

现有的工具需要对Json代表什么有一个深刻的理解。OR假定所有团队成员都了解该架构以对其进行定义/编辑。

But, in practical I found people sharing request response in google-doc to get approval. Google-doc is fine but when I share a proposed response of my service in nested Json format in google-doc ,other teams struggles to understand it, play with it and make an intuited mind model of it.

但是，实际上，我发现人们在google-doc中共享请求响应以获取批准。 Google-doc很好，但是当我在google-doc中以嵌套Json格式共享我对服务的建议响应时，其他团队则难以理解，使用它并为其建立直观的思维模型。

Hence, created a tool where one can:

因此，创建了一种工具，可以在其中进行以下操作：

1 . Add a JSON structure and share it with a link .2. Other team can play with the Json tree structure.3. A documentation panel where one can view/add documentation.

1。 添加一个JSON结构并与链接共享2。 其他团队可以使用Json树结构。 3.一个文档面板，可以在其中查看/添加文档。

---

---

Source Code: https://github.com/bhuvangu/jsondoc.online

源代码： https : //github.com/bhuvangu/jsondoc.online

motivation: Personal problem at work

动机：工作中的个人问题

---

---

翻译自: https://www.freecodecamp.org/news/another-json-documentation-tool/

json接口文档编写工具