Ένα άλλο εργαλείο τεκμηρίωσης Json

Υπάρχουν πολλά εργαλεία τεκμηρίωσης δομής JSON, έχω δημιουργήσει ένα ακόμη για τη δουλειά γραφείου μου .//jsondoc.online

Για μένα μπορώ να τα ταξινομήσω σε:

1. Κωδικός διακοσμητικά εργαλεία

Εργαλεία που απαιτούν προσθήκη σχολιασμού σε κώδικα και στη συνέχεια εργαλεία δημιουργούν τεκμηρίωση. Για παράδειγμα: swagger

2. Δηλωτικά εργαλεία

Εργαλεία που απαιτούν τη συμπλήρωση κειμένου σε ένα συγκεκριμένο σχήμα και, στη συνέχεια, τα εργαλεία το αναλύουν και δημιουργούν προβολή τεκμηρίωσης. Για παράδειγμα: Προδιαγραφή Json Schema

Γιατί να δημιουργήσετε ένα άλλο εργαλείο;

Τα υπάρχοντα εργαλεία απαιτούν μια ισχυρή / σαφή κατανόηση του τι αντιπροσωπεύει ο Json

Ή

Υποθέτει ότι όλα τα μέλη της ομάδας / ομάδες κατανοούν το σχήμα για να το ορίσουν / να το επεξεργαστούν.

Όμως, στην πράξη βρήκα άτομα που μοιράζονταν απάντηση αιτήματος στο google-doc για να λάβουν έγκριση.

Το Google-doc είναι εντάξει, αλλά όταν μοιράζομαι μια προτεινόμενη απάντηση της υπηρεσίας μου σε ένθετη μορφή Json στο google-doc, άλλες ομάδες αγωνίζονται να το καταλάβουν, να παίξουν μαζί του και να δημιουργήσουν ένα διαισθητικό μοντέλο μυαλού αυτού.

Ως εκ τούτου, δημιούργησε ένα εργαλείο όπου μπορεί κανείς:

1. Προσθέστε μια δομή JSON και μοιραστείτε την με έναν σύνδεσμο.

2. Άλλη ομάδα μπορεί να παίξει με τη δομή του δέντρου Json.

3. Ένα πάνελ τεκμηρίωσης όπου μπορεί κανείς να δει / προσθέσει τεκμηρίωση.

Πηγαίος κώδικας: //github.com/bhuvangu/jsondoc.online

κίνητρο: Προσωπικό πρόβλημα στην εργασία