Et andet Json-dokumentationsværktøj

Der er mange JSON-strukturdokumentationsværktøjer, jeg har bygget en mere til mit kontorarbejde. //Jsondoc.online

For mig kan jeg klassificere dem i:

1. Kode dekorative værktøjer

Værktøjer, der kræver at tilføje en kommentar i kode og derefter generere værktøjer dokumentation ud af det. F.eks .: swagger

2. Erklæringsværktøjer

Værktøjer, der kræver at udfylde tekst i et bestemt skema, analyserer derefter værktøjer og genererer dokumentationsvisning. For eksempel: Json Schema-specifikation

Hvorfor oprette et andet værktøj?

Eksisterende værktøjer kræver en stærk / klar forståelse af, hvad Json repræsenterer

ELLER

Det forudsætter, at alle teammedlemmer / teams forstår skemaet til at definere / redigere det.

Men i praksis fandt jeg folk, der delte anmodning om svar i google-doc for at få godkendelse.

Google-doc er fint, men når jeg deler et foreslået svar fra min tjeneste i indlejret Json-format i google-doc, kæmper andre hold med at forstå det, lege med det og lave en intuitiv tankemodel af det.

Derfor skabte et værktøj, hvor man kan:

1. Tilføj en JSON-struktur, og del den med et link.

2. Andet hold kan spille med Json-træstrukturen.

3. Et dokumentationspanel, hvor man kan se / tilføje dokumentation.

Kildekode: //github.com/bhuvangu/jsondoc.online

motivation: Personligt problem på arbejdspladsen