เครื่องมือสำหรับนักพัฒนา · JSON ฟอร์แมตเตอร์ & เครื่องมือตรวจสอบความถูกต้อง
การอ่านคำตอบ API แบบย่อ: ทำไมการพิมพ์ที่สวยงามถึงต้องหรี่ตามอง
· เหตุใดจึงสำคัญ
json นักพัฒนาเวิร์กโฟลว์ การตรวจสอบ
Minified JSON มีไว้สำหรับเครื่องจักร โพสต์นี้จะอธิบายว่าทำไมเซิร์ฟเวอร์จึงตัดช่องว่าง สิ่งที่คุณสูญเสียไปเมื่อคุณดีบักในบรรทัดเดียว และวิธีที่การจัดรูปแบบเปลี่ยนเพย์โหลดเป็นสิ่งที่สมเหตุสมผล
สามสิบกิโลไบต์ในหนึ่งบรรทัด
สามสิบกิโลไบต์ในหนึ่งบรรทัด - เนื้อหาการตอบสนองจากแผงเครือข่ายและฟิลด์ที่คุณไม่พบในนั้น การค้นหาอาจค้นหาคีย์แต่ให้บริบทเพียงเล็กน้อยเกี่ยวกับออบเจ็กต์หลัก บันทึกใกล้เคียง หรือขอบเขตอาเรย์ การสแกนแนวนอนยังทำให้ชื่อคุณสมบัติที่ซ้ำกันแยกไม่ออก ซึ่งเป็นเรื่องปกติในเพย์โหลด API ที่มีการแบ่งหน้า
การจัดรูปแบบแยกวิเคราะห์และจัดลำดับเอกสารใหม่ มันเผยให้เห็นโครงสร้างแต่สามารถทำให้การสะกดตัวเลข การยกเว้น และช่องว่างเป็นปกติได้ นอกจากนี้ แผงยังรายงานสรุปรูปร่างที่มีประเภทรูท จำนวนคีย์หรือรายการ ความลึก และจำนวนโหนด ทำให้ตรวจสอบผลลัพธ์ได้ง่ายกว่าการปรากฏเพียงอย่างเดียว คงการตอบสนองแบบดิบไว้เมื่อความเที่ยงตรงของคำศัพท์มีความสำคัญ โดยเฉพาะเมื่อมีจำนวนมาก สัญลักษณ์เลขชี้กำลัง และข้อความที่ใช้ Escape
เหตุใดเซิร์ฟเวอร์จึงย่อขนาด — แบนด์วิธ การโต้ตอบการบีบอัด และการตั้งค่าซีเรียลไลเซอร์เริ่มต้น และเหตุใดจึงไม่ช่วยผู้อ่านที่เป็นมนุษย์เลย
เหตุใดเซิร์ฟเวอร์จึงย่อขนาด — แบนด์วิธ การโต้ตอบการบีบอัด และการตั้งค่าซีเรียลไลเซอร์เริ่มต้น และเหตุใดจึงไม่ช่วยผู้อ่านที่เป็นมนุษย์เลย การลบการเยื้องจะลดจำนวนไบต์ที่ไม่มีการบีบอัด และหลีกเลี่ยงการใช้จ่าย CPU เพื่อสร้างช่องว่างสำหรับตกแต่ง การบีบอัดแบบใช้งานทั่วไปจะยุบช่องว่างซ้ำๆ ได้อย่างมีประสิทธิภาพ ดังนั้นการประหยัดที่ถ่ายโอนอาจน้อยกว่าความแตกต่างดิบ แต่เอาต์พุตที่มีขนาดกะทัดรัดยังคงเหมือนเดิม
เครื่องจักรใช้โทเค็นมากกว่าการจัดตำแหน่งด้วยภาพ และโดยปกติแล้วไคลเอ็นต์จะแยกส่วนเนื้อหาออกเป็นโครงสร้างข้อมูลทันที มนุษย์ที่ตรวจสอบคำตอบเดียวมีข้อกำหนดตรงกันข้าม นั่นคือการขึ้นบรรทัดใหม่อย่างมั่นคงและการเยื้องเผยให้เห็นความเป็นเจ้าของและการซ้อน พิมพ์สำเนาที่บันทึกไว้เพื่อการวินิจฉัย แทนที่จะขอให้จุดสิ้นสุดการผลิตส่งเอาต์พุตแบบละเอียด ซึ่งสามารถเปลี่ยนแคช ขนาดการตอบสนอง หรือพฤติกรรมของเซิร์ฟเวอร์ในระหว่างเหตุการณ์ได้
โครงสร้างใดที่มองเห็นได้หลังจากการฟอร์แมต
โครงสร้างใดที่มองเห็นได้หลังจากการฟอร์แมต - ความลึกของการซ้อน ความยาวของอาเรย์ วัตถุว่าง และค่าว่างที่ซ่อนอยู่ในตอนท้าย การเยื้องแสดงว่า `status` เป็นของการตอบกลับ รายการ หรือเจ้าของที่ฝังไว้ บรรทัดที่แยกกันเปิดเผยบันทึกที่ซ้ำกัน และสร้าง `{}` เดี่ยวๆ ในหมู่วัตถุที่มีประชากรให้มองเห็นได้ชัดเจนโดยไม่ต้องเปลี่ยนความหมายที่แยกวิเคราะห์
สรุปรูปร่างให้การตรวจสอบอีกอย่าง: รูทอาร์เรย์ที่มีรายการเป็นศูนย์จะบอกเล่าเรื่องราวที่แตกต่างจากออบเจ็กต์ที่มีอาร์เรย์ `items` ว่างเปล่า ในขณะที่ความลึกสูงสุดสามารถเปิดเผยผลลัพธ์ที่รวมไว้โดยไม่คาดคิด การจัดรูปแบบยังให้ความกระจ่างว่าวงเล็บปิดคอนเทนเนอร์ที่คาดไว้หรือไม่ ใช้การพับในตัวแก้ไขเพื่อยุบสาขาที่ไม่เกี่ยวข้องและแสดงเส้นทางไปยังค่าที่ต้องสงสัย
การตรวจจับจุดบกพร่องที่เกิดขึ้นจริง
การระบุจุดบกพร่องที่เกิดขึ้นจริง เช่น สตริงที่คาดว่าจะเป็นตัวเลข คีย์ที่หายไปเทียบกับค่า Null และอาร์เรย์ที่มีองค์ประกอบเดียว การพิมพ์ที่สวยงามทำให้ประเภทต่างๆ ชัดเจนผ่านเครื่องหมายคำพูดและตัวอักษร: `"0"`, `0`, `false` และ `null` เป็นค่าที่แตกต่างกันสี่ค่าที่บันทึกแบบย่อสามารถเบลอได้ในระหว่างการตรวจสอบอย่างเร่งด่วน
โครงสร้างยังแยกความแตกต่างระหว่างการไม่มีและความว่างเปล่าอย่างชัดเจน `nextCursor` ที่หายไปอาจหมายความว่าเซิร์ฟเวอร์ละเว้นข้อมูลเมตาของการแบ่งหน้า ในขณะที่ `"nextCursor":null` อาจตั้งใจทำเครื่องหมายหน้าสุดท้าย อาร์เรย์ `items` ว่างเปล่าแตกต่างจากคุณสมบัติ `items` ที่ขาดหายไป ซึ่งทำให้ตรรกะทางเลือกของไคลเอ็นต์ การจัดรูปแบบทำให้เห็นความแตกต่างเหล่านี้ แต่สัญญา API จะกำหนดว่ารูปแบบใดถูกต้อง
ตัวอย่างการทำงาน: การตอบกลับแบบแบ่งหน้า
ตัวอย่างการทำงาน: การตอบกลับแบบแบ่งหน้า - จัดรูปแบบ ค้นหาเคอร์เซอร์หน้าถัดไป และสังเกตว่าอาร์เรย์รายการว่างเปล่า เพย์โหลดขนาดกะทัดรัด เช่น `{"items":[],"page":{"next":"abc","count":0}}` ถูกต้อง แต่เคอร์เซอร์และการนับขัดแย้งกันเนื่องจากไม่มีบันทึก ข้อมูลเมตาของการแบ่งหน้ากลุ่มการเยื้องแยกจากข้อมูลผลลัพธ์
มุมมองนั้นแนะนำคำถามที่เป็นรูปธรรม: ตัวกรองลบทุกรายการหลังจากคำนวณเคอร์เซอร์แล้ว เป็น `count` หน้าท้องถิ่นหรือทั้งหมด และควรมีเคอร์เซอร์ถัดไปสำหรับหน้าว่างหรือไม่ ตัวจัดรูปแบบไม่สามารถตอบคำถามได้ แต่จะเปลี่ยนบรรทัดทึบหนึ่งบรรทัดเป็นช่องที่สามารถตรวจสอบกับพารามิเตอร์คำขอและเอกสารประกอบได้ เก็บการตอบสนองและส่วนหัวสถานะเดิมไว้เพื่อเป็นหลักฐาน
เปรียบเทียบสองคำตอบ
การเปรียบเทียบสองคำตอบ - การจัดรูปแบบทั้งสองด้วยการเยื้องเหมือนกัน ดังนั้นแผงการเปรียบเทียบข้อความจะเน้นเฉพาะความแตกต่างที่แท้จริงเท่านั้น รูปแบบที่สอดคล้องกันช่วยป้องกันไม่ให้การจัดอนุกรมแบบกะทัดรัดของเพย์โหลดหนึ่งสร้างความแตกต่างทั้งเอกสารกับสำเนาที่มีการเยื้อง มันทำให้ค่าที่เปลี่ยนแปลง บันทึกที่แทรก และคีย์ที่หายไปใช้บรรทัดที่แปลเป็นภาษาท้องถิ่น แทนที่จะเปลี่ยนกระแสอักขระที่อ่านไม่ได้
ควบคุมสนามที่ผันผวนก่อนที่จะสรุปผล รหัสคำขอ การประทับเวลา ลายเซ็น และคอลเลกชันที่ไม่เรียงลำดับสามารถครอบงำการเปรียบเทียบข้อความได้ แม้ว่าข้อมูลธุรกิจจะมีเสถียรภาพก็ตาม อย่าจัดเรียงคีย์โดยไม่ตั้งใจหากลำดับของสมาชิกเป็นหลักฐานที่คุณต้องเก็บรักษาไว้ และจำไว้ว่าลำดับอาร์เรย์คือข้อมูล การเปรียบเทียบแบบคำนึงถึงโครงสร้างจะดีกว่าเมื่อการสั่งซื้อไม่เกี่ยวข้องกับสัญญา แต่การทำให้เป็นอนุกรมจะแตกต่างกันไป
สิ่งนี้ไม่ครอบคลุมถึง
สิ่งนี้ไม่ครอบคลุมถึง — การถอดรหัสเนื้อหาที่ถูกบีบอัดหรือเข้ารหัส และการตรวจสอบรูปแบบไบนารี เช่น Protocol Buffers ส่วนเนื้อหาที่แสดงเป็น Base64, gzip ไบต์ หรือซองจดหมายที่เข้ารหัสจะต้องถอดรหัสก่อนโดยมีความรู้เกี่ยวกับการเข้ารหัสเนื้อหา การป้อนอักขระเหล่านั้นไปยังตัวแยกวิเคราะห์ JSON ทำให้เกิดข้อผิดพลาดทางไวยากรณ์ที่ไม่กล่าวถึงข้อความที่ซ่อนอยู่
Pretty-printing ยังไม่ได้ตรวจสอบสคีมา OpenAPI อธิบายรหัสสถานะเซิร์ฟเวอร์ หรือพิสูจน์ว่าการดีซีเรียลไลซ์ไคลเอ็นต์ใช้ประเภทเดียวกัน ไม่สามารถกู้คืนการดักจับเครือข่ายที่ถูกตัดทอนหรือรักษาโทเค็นตัวเลขที่แน่นอนหลังจากการแยกวิเคราะห์ JavaScript ที่สูญเสียไป ใช้เครื่องมือเฉพาะโปรโตคอลสำหรับเพย์โหลดไบนารีและเก็บส่วนหัว บริบทคำขอ และไบต์ดิบควบคู่ไปกับการเรนเดอร์ที่มนุษย์สามารถอ่านได้
ประเด็นสำคัญ: จัดรูปแบบก่อน จากนั้นจึงแก้ไขจุดบกพร่อง
ประเด็นสำคัญ: จัดรูปแบบก่อน จากนั้นจึงแก้ไขข้อบกพร่อง ใช้ตัวเลือกการเยื้องของตัวจัดรูปแบบเพื่อแสดงลำดับชั้นของเพย์โหลดก่อนที่จะสร้างทฤษฎี ค้นหาสาขาที่เกี่ยวข้อง ตรวจสอบประเภทค่า และแยกแยะสถานะที่ขาดหายไป เป็นโมฆะ และว่างเปล่า เปรียบเทียบการตอบสนองภายใต้เค้าโครงเดียวเมื่อมีตัวอย่างที่ทราบว่าใช้งานได้ดี ในขณะที่การรักษาอินพุตดิบไว้สำหรับการกำหนดรายละเอียดซ้ำอาจทำให้เป็นมาตรฐาน
JSON ที่อ่านได้ช่วยลดความพยายามในการมองเห็น ไม่ได้แทนที่สัญญา API ตรวจสอบคำจำกัดความของการแบ่งหน้า ข้อกำหนดสคีมา ส่วนหัวสถานะ และพารามิเตอร์คำขอหลังจากมองเห็นฟิลด์ที่น่าสงสัย ToolAcre ดำเนินการแยกวิเคราะห์และจัดรูปแบบในเบราว์เซอร์ ดังนั้นเอกสารที่ให้มาจะไม่ถูกโพสต์ไปยังเซิร์ฟเวอร์แอปพลิเคชัน ToolAcre แต่การจับข้อมูลที่ละเอียดอ่อนควรยังคงถูกย่อให้เล็กสุดตามนโยบาย