Hay muchas herramientas de documentación de estructura JSON, he creado una más para mi trabajo de oficina .//jsondoc.online

Para mi los puedo clasificar en:

1. Codifique herramientas decorativas

Herramientas que requieren agregar una anotación en el código y luego las herramientas generan documentación. Por ejemplo: swagger

2. Herramientas declarativas

Herramientas que requieren completar texto en un esquema en particular, luego las herramientas lo analizan y generan vista de documentación. Por ejemplo: especificación de esquema Json

¿Por qué crear otra herramienta?

Las herramientas existentes requieren una comprensión clara y sólida de lo que representa Json

O

Asume que todos los miembros / equipos del equipo comprenden el esquema para definirlo / editarlo.

Pero, en la práctica, encontré a personas que compartían una respuesta de solicitud en google-doc para obtener la aprobación.

Google-doc está bien, pero cuando comparto una respuesta propuesta de mi servicio en formato Json anidado en google-doc, otros equipos luchan por entenderlo, jugar con él y hacer un modelo mental intuitivo.

Por lo tanto, creó una herramienta donde se puede:

1. Agregue una estructura JSON y compártala con un enlace.

2. Otro equipo puede jugar con la estructura del árbol Json.

3. Un panel de documentación donde se puede ver / agregar documentación.

Código fuente: //github.com/bhuvangu/jsondoc.online

motivación: problema personal en el trabajo