บทนำ
เจสัน มีอยู่ทุกที่ในงาน API แต่เพย์โหลดดิบนั้นยากที่จะให้เหตุผลเมื่อมาถึงแบบย่อเล็กสุด ซ้อนกันลึก หรือเสียหายบางส่วน ตัวฟอร์แมตช่วยได้เพราะมันเปลี่ยนโครงสร้างกลับเป็นสิ่งที่มนุษย์สามารถสแกน ตรวจแก้จุดบกพร่อง และอธิบายได้
สำหรับจุดประสงค์ในการค้นหาที่เน้นผู้เริ่มต้น นั่นมีความสำคัญมาก ผู้อ่านจำนวนมากที่ใช้แบบสอบถามนี้ไม่ได้ขอทฤษฎีพาร์เซอร์ขั้นสูง พวกเขาต้องการวิธีที่ปฏิบัติได้จริงในการรับการตอบสนอง API ที่อ่านไม่ออก และทำความเข้าใจให้เร็วพอที่จะดำเนินการต่อไป
คู่มือนี้จึงต้องทำมากกว่าอธิบายการเยื้อง ควรชี้แจงว่าการเปลี่ยนแปลงรูปแบบใด เมื่อการตรวจสอบมีความสำคัญ เหตุใดการประมวลผลในเครื่องจึงมีประโยชน์ และวิธีการย้ายจากเพย์โหลดดิบไปเป็นอาร์ติแฟกต์การดีบักที่แชร์ได้
การจัดรูปแบบใดที่เปลี่ยนแปลงจริง ๆ
การจัดรูปแบบไม่เปลี่ยนความหมายของ JSON มันเปลี่ยนการนำเสนอ การขึ้นบรรทัดใหม่ การเยื้อง และการเว้นวรรคทำให้วัตถุและอาร์เรย์สามารถอ่านได้อีกครั้งโดยไม่ต้องเปลี่ยนเพย์โหลด
นั่นเป็นสิ่งสำคัญเนื่องจากผู้เริ่มต้นมักกังวลว่าอาจทำให้ข้อมูลเสียหายโดยการตกแต่งให้สวยงาม คำอธิบายที่ปลอดภัยกว่าคือการจัดรูปแบบช่วยให้มนุษย์ตรวจสอบโครงสร้างได้ ไม่ใช่ขั้นตอนการแปลงข้อมูล
เหตุใดการตรวจสอบจึงอยู่ในเวิร์กโฟลว์เดียวกัน
JSON ที่อ่านได้นั้นมีประโยชน์ แต่ JSON ที่ถูกต้องคือจุดตรวจสอบแรกที่แท้จริง หากเพย์โหลดมีรูปแบบไม่ถูกต้อง จะไม่มีการจัดรูปแบบใดๆ ที่จะแก้ไขได้โดยอัตโนมัติ เครื่องมือจำเป็นต้องแสดงว่าไวยากรณ์แตกตรงไหนเพื่อให้ผู้ใช้สามารถแก้ไขได้
นี่คือสาเหตุที่การจัดรูปแบบและการตรวจสอบความถูกต้องสอดคล้องกันบนพื้นผิวเครื่องมือเดียวกัน ผู้ใช้ไม่ควรต้องข้ามไปมาระหว่างยูทิลิตีที่แยกจากกันเพียงเพื่อดูว่า JSON เสียหรืออ่านไม่ออกเท่านั้น
- จัดรูปแบบเมื่อเพย์โหลดถูกต้องแต่ยุ่งเหยิง
- ตรวจสอบเมื่อเพย์โหลดอาจมีรูปแบบไม่ถูกต้อง
- ใช้ทั้งสองอย่างเมื่อทำการดีบักการตอบสนอง API อย่างรวดเร็ว
เวิร์กโฟลว์เริ่มต้นง่ายๆ สำหรับเพย์โหลด API
เริ่มต้นด้วยการวางการตอบกลับแบบ Raw ลงในฟอร์แมตเตอร์ หากการตรวจสอบล้มเหลว ให้แก้ไขปัญหาด้านไวยากรณ์ก่อน หากการตรวจสอบผ่าน ให้สแกนคีย์ระดับบนสุด จากนั้นย้ายไปยังอาร์เรย์และอ็อบเจ็กต์ที่ซ้อนกันโดยมีแผนผังโครงสร้างทางจิตที่ชัดเจนยิ่งขึ้น
เมื่อ JSON สามารถอ่านได้ การคัดลอกส่วนย่อยที่เป็นประโยชน์ลงในเอกสารประกอบ ตั๋ว หรือการแชทในทีมจะง่ายขึ้นมาก นั่นเป็นส่วนหนึ่งของเวิร์กโฟลว์ที่แท้จริงเช่นกัน โดยเฉพาะอย่างยิ่งเมื่อการแก้ไขข้อบกพร่องเป็นการทำงานร่วมกัน
- วางหรืออัปโหลดเพย์โหลด JSON
- เรียกใช้รูปแบบหรือตรวจสอบความถูกต้องก่อน
- ตรวจสอบเส้นทางคีย์และค่าที่ซ้อนกัน
- คัดลอกผลลัพธ์ที่ล้างแล้วสำหรับเอกสาร ตั๋ว หรือการตรวจสอบโค้ด
เหตุใดการจัดรูปแบบ JSON ที่เน้นเบราว์เซอร์เป็นหลักจึงสามารถทำได้ เรื่อง
เพย์โหลด API มักประกอบด้วยข้อมูลภายใน โปรแกรมทดสอบ โทเค็นชั่วคราว หรือการตอบกลับเฉพาะสภาพแวดล้อมที่ไม่ควรวางลงในบริการของบุคคลที่สามโดยไม่ได้ตั้งใจ ฟอร์แมตเตอร์ที่เน้นเบราว์เซอร์เป็นหลักจะช่วยลดความเสี่ยงดังกล่าวด้วยการรักษาเวิร์กโฟลว์ไว้ในเครื่อง
สิ่งนี้มีความเกี่ยวข้องโดยเฉพาะอย่างยิ่งสำหรับทีมที่กำลังแก้ไขจุดบกพร่องในขั้นตอนหรือระบบภายใน แม้ว่าเพย์โหลดจะไม่เป็นความลับอย่างเป็นทางการ แต่มักจะปลอดภัยกว่าและเร็วกว่าในการรักษาขั้นตอนการฟอร์แมตบนอุปกรณ์
สิ่งที่ผู้ใช้ควรทำหลังจากอ่านคู่มือนี้
หากงานถัดไปคือความสามารถในการอ่านและการตรวจสอบอย่างแท้จริง ให้เปิด เจสัน Formatter หากงานเป็นการเปรียบเทียบ ให้ย้ายไปยัง Diff Checker หรือเวิร์กโฟลว์การเปรียบเทียบในตัว หากงานคือการแปลงระหว่างรูปแบบข้อมูล ให้ย้ายไปยัง CSV เจสัน Converter คำแนะนำจะทำงานได้ดีที่สุดเมื่อการดำเนินการถัดไปนั้นชัดเจน
โครงสร้างดังกล่าวยังช่วยปรับปรุงคุณภาพของ SEO เนื่องจากเชื่อมโยงแบบสอบถามด้านการศึกษาเข้ากับคลัสเตอร์เวิร์กโฟลว์ที่กว้างขึ้น แทนที่จะถือว่าบทความเป็นเนื้อหาที่แยกออกมา