Egy másik Json dokumentációs eszköz

Sok JSON struktúra-dokumentációs eszköz létezik, az irodai munkámhoz még egyet építettem .//jsondoc.online

Számomra az alábbiakat tudom osztályozni:

1. Díszítő eszközök kódolása

Azok az eszközök, amelyekhez megjegyzéseket kell hozzáadni a kódba, majd az eszközök dokumentációt generálnak belőle Például: swagger

2. Deklaratív eszközök

Eszközök, amelyek megkövetelik a szöveg kitöltését egy adott sémában, majd az eszközök elemzik azt, és létrehozzák a dokumentáció nézetet. Például: Json Schema specifikáció

Miért kell létrehozni egy másik eszközt?

A meglévő eszközök megkövetelik a Json által képviselt erőteljes / egyértelmű megértést

VAGY

Feltételezi, hogy az összes csapattag / csapat megérti a sémát annak meghatározásához / szerkesztéséhez.

De gyakorlatilag azt találtam, hogy az emberek megosztják a kérés válaszát a google-doc-ban, hogy jóváhagyást kapjanak.

A Google-doc rendben van, de amikor megosztom a szolgáltatásom javasolt válaszát beágyazott Json formátumban google-doc-ban, más csapatok küzdenek, hogy megértsék, játszhassanak vele, és intuitív gondolkodásmódot alkossanak róla.

Ezért létrehozott egy eszközt, ahol:

1. Adjon hozzá egy JSON-struktúrát, és ossza meg egy hivatkozással.

2. Más csapat játszhat a Json fa szerkezetével.

3. Dokumentációs panel, ahol megtekinthető / hozzáadható dokumentáció.

Forráskód: //github.com/bhuvangu/jsondoc.online

motiváció: Személyes probléma a munkahelyen