คู่มือ
ภาพรวมโดยย่อ
หัวข้อที่มีชื่อว่า “ภาพรวมโดยย่อ”คู่มือเหล่านี้ช่วยเชื่อม NextPDF เข้ากับสภาพแวดล้อมที่โค้ดทำงานจริง แท็บนี้เริ่มต้นด้วย รายการตรวจสอบการดำเนินงานในระบบจริง แล้วจึงครอบคลุมห้าด้านตามลำดับการนำไปใช้ ได้แก่ การผสานการทำงานกับเฟรมเวิร์กและตัวเรนเดอร์, เซิร์ฟเวอร์ NextPDF Connect, Python SDK, การพัฒนาส่วนขยายเอนจิน และการแก้ไขปัญหา แต่ละส่วนด้านล่างเริ่มจากหน้าศูนย์กลางของส่วนนั้น แล้วตามด้วยหน้าที่ใช้งานบ่อยที่สุด
หากต้องการสูตรตามงานที่คัดลอกไปใช้ได้ ให้ดู Cookbook (สูตรการใช้งาน) หากต้องการพื้นผิว Application Programming Interface (API) ที่ผ่านการตรวจสอบแล้วและตารางการรองรับ ให้ดู ข้อมูลอ้างอิง
การผสานการทำงาน
หัวข้อที่มีชื่อว่า “การผสานการทำงาน”แพ็กเกจทั้งแปดตัวเชื่อมเอนจินหลักกับเฟรมเวิร์ก ตัวเรนเดอร์ของเบราว์เซอร์ บริการ edge เครื่องมือสร้าง และเส้นทางการย้ายจากระบบเดิม หมวดของแต่ละแพ็กเกจใช้โครงสร้างคู่มือแบบเดียวกัน ได้แก่ ภาพรวม การติดตั้ง การเริ่มต้นใช้งานอย่างรวดเร็ว การกำหนดค่า API คู่มือนักพัฒนา การใช้งานในระบบจริง ความปลอดภัย และการแก้ไขปัญหา ดังนั้นเมื่อเข้าใจแพ็กเกจหนึ่งแล้ว จึงนำความเข้าใจนั้นไปใช้กับแพ็กเกจอื่นตามโครงสร้างเดียวกันได้
| หน้า | ใช้สำหรับ |
|---|---|
| การผสานการทำงาน | แผนผังส่วนขยายและคู่มือการเลือกแพ็กเกจ อ่านหน้านี้ก่อนเลือกแพ็กเกจ |
| ดัชนี API สำหรับงานผสานรวม | ตรวจสอบว่าหน้า API ของส่วนขยายใดครอบคลุมพื้นผิวของเฟรมเวิร์ก ตัวเรนเดอร์ ทรานสปอร์ต และเครื่องมือสร้างแต่ละอย่าง |
| NextPDF สำหรับ Laravel | อะแดปเตอร์สำหรับเฟรมเวิร์ก Laravel |
| NextPDF สำหรับ Symfony | อะแดปเตอร์สำหรับเฟรมเวิร์ก Symfony |
| NextPDF สำหรับ CodeIgniter | อะแดปเตอร์สำหรับเฟรมเวิร์ก CodeIgniter |
| NextPDF Artisan | บริดจ์ตัวเรนเดอร์ Chrome สำหรับการเรนเดอร์ HTML ระดับเบราว์เซอร์ |
| NextPDF Cloudflare | เส้นทางการปรับใช้บน edge ของ Cloudflare |
| NextPDF Gotenberg | บริดจ์ตัวเรนเดอร์ Gotenberg |
| ความเข้ากันได้กับ TCPDF | compatibility shim สำหรับโค้ดเบสที่กำลังย้ายออกจาก TCPDF |
| NextPDF Backport Builder | เครื่องมือสร้างสำหรับรันไทม์ PHP รุ่นเก่า |
NextPDF Connect
หัวข้อที่มีชื่อว่า “NextPDF Connect”แพ็กเกจ nextpdf/server รันเอนจินเป็นบริการที่ทำงานต่อเนื่องยาวนานและเป็นรีจิสทรีเครื่องมือชุดเดียวที่ให้ผลลัพธ์แบบกำหนดได้แน่นอน โดยให้บริการผ่าน Model Context Protocol (MCP), Representational State Transfer (REST) และ gRPC และมีเกตการอนุมัติแบบมีมนุษย์ร่วมตัดสินใจสำหรับเครื่องมือที่มีความเสี่ยงสูง
| หน้า | ใช้สำหรับ |
|---|---|
| NextPDF Connect | หน้าศูนย์กลางของส่วนนี้ ครอบคลุมแนวคิด การกำหนดค่า และการดำเนินงานของเซิร์ฟเวอร์ |
| ภาพรวมของ NextPDF Connect | ขอบเขตของแพ็กเกจและทรานสปอร์ตทั้งสาม |
| เริ่มต้นใช้งาน NextPDF Connect อย่างรวดเร็ว | การทำ handshake MCP ครั้งแรกที่ใช้งานได้จริง และคำขอเรนเดอร์ REST ที่สอดคล้องกัน |
| การกำหนดค่า Connect | ไฟล์ YAML ของ MCP และตัวแปรสภาพแวดล้อม NEXTPDF_* |
| เอกสารอ้างอิง Connect API | เครื่องมือที่ลงทะเบียนทั้งหมด สัญลักษณ์ gRPC รายการแบบจำลองข้อผิดพลาด และขีดจำกัดอัตรา |
| การปรับใช้ Connect | โปรไฟล์ worker ของ RoadRunner, Docker และสโตร์ที่ใช้ Redis เป็นแบ็กเอนด์ |
| ความปลอดภัยและการดำเนินงานของ NextPDF Connect | การพิสูจน์ตัวตน ความปลอดภัยของทรานสปอร์ต และแบบจำลองภัยคุกคาม |
ทรานสปอร์ตแต่ละแบบมีหน้าอ้างอิงแยกของตนเอง
| หน้า | ใช้สำหรับ |
|---|---|
| ทรานสปอร์ต MCP | การจัดเฟรม JSON-RPC 2.0 ผ่าน standard input และ standard output |
| การรับส่ง REST | สัญญา OpenAPI 3.1 การพิสูจน์ตัวตนแบบ bearer และเส้นทางที่จำกัดตามระดับ |
| ทรานสปอร์ต gRPC | บริการ nextpdf.connect.v1 การสตรีมจากฝั่งเซิร์ฟเวอร์ และการพิสูจน์ตัวตนผ่าน metadata |
Python SDK
หัวข้อที่มีชื่อว่า “Python SDK”การแยกข้อมูล PDF ที่พร้อมใช้อ้างอิงสำหรับแอปพลิเคชัน Python เอเจนต์ และบรรทัดคำสั่ง โดยใช้ NextPDF Connect endpoint เป็นแบ็กเอนด์รองรับ
| หน้า | ใช้สำหรับ |
|---|---|
| Python SDK: ชุดพัฒนาซอฟต์แวร์สำหรับ Python | ศูนย์กลางของส่วนนี้สำหรับแพ็กเกจ Python nextpdf |
| ภาพรวม Python SDK | SDK ทำอะไรได้บ้างและสัมพันธ์กับ Connect อย่างไร |
| เริ่มต้นใช้งาน Python SDK แบบรวดเร็ว | ติดตั้งด้วย pip install nextpdf แล้วกำหนดให้ไคลเอ็นต์ชี้ไปยังเซิร์ฟเวอร์ของคุณ |
| ข้อมูลอ้างอิง API ของ Python SDK | คลาสไคลเอ็นต์ เมท็อด และผลลัพธ์ที่กำหนดชนิดไว้ |
| อินเทอร์เฟซบรรทัดคำสั่งสำหรับ Python | อินเทอร์เฟซบรรทัดคำสั่งสำหรับเวิร์กโฟลว์การแยกข้อมูล |
| เซิร์ฟเวอร์ Python MCP | การเปิดให้เอเจนต์ที่สื่อสารด้วย MCP เข้าถึง SDK |
ขยายความสามารถของเอนจิน
หัวข้อที่มีชื่อว่า “ขยายความสามารถของเอนจิน”Service Provider Interface (SPI) สาธารณะช่วยให้เพิ่มความสามารถได้โดยไม่ต้องแยกโค้ด (fork) โดยทำหน้าที่เป็นสัญญาสำหรับฟอนต์ เอนจินเลย์เอาต์ ตัวรับฟังเหตุการณ์ และแบ็กเอนด์การลงนาม พร้อมคำรับรองด้านความเสถียรที่ชัดเจนสำหรับแต่ละส่วน
| หน้า | ใช้สำหรับ |
|---|---|
| การพัฒนาส่วนขยาย | สิ่งที่ขยายได้และคำรับรองด้านความเสถียรที่รองรับ |
| กฎความเสถียรของ SPI | สัญญาความเข้ากันได้ย้อนหลังที่ส่วนขยายพึ่งพาได้ |
| ฟอนต์แบบกำหนดเอง: สัญญาของ FontRegistry | การลงทะเบียนและการแจกจ่ายฟอนต์ของตนเอง |
| เลย์เอาต์เอนจินแบบกำหนดเองและการดักจับข้อความ | การแทนที่หรือดักจับพฤติกรรมการทำเลย์เอาต์ |
| ตัวกระตุ้นการทำงานและตัวรับฟังเหตุการณ์ | การสังเกตและตอบสนองต่อวงจรชีวิตของเอกสาร |
| สัญญาสำหรับผู้ให้บริการ KMS | การจัดหาคีย์จาก Key Management Service (KMS) ของตนเอง |
การแก้ไขปัญหา
หัวข้อที่มีชื่อว่า “การแก้ไขปัญหา”รายการที่ไล่จากอาการไปสู่แนวทางแก้ไข โดยอิงจากการจัดหมวดหมู่ข้อยกเว้นของเอนจินเอง ให้เริ่มจากสิ่งที่สังเกตเห็น ไม่ใช่จากชื่อคลาส
| หน้า | ใช้สำหรับ |
|---|---|
| การแก้ไขปัญหา | หน้าศูนย์กลางของฐานความรู้ รวมวิธีจัดโครงสร้างรายการและจุดเริ่มต้นที่ควรใช้ |
| การแก้ไขปัญหา: ฟอนต์และการแท็ก | ความล้มเหลวในการฝังฟอนต์และการแท็กโครงสร้าง |
| การแก้ไขปัญหา: การเข้ารหัสลับและสิทธิ์ | ความล้มเหลวด้านการเข้ารหัสลับ รหัสผ่าน และสิทธิ์ |
| การแก้ไขปัญหา: หน่วยความจำและประสิทธิภาพ | เพดานหน่วยความจำและปัญหาด้านปริมาณงาน |
| การแก้ไขปัญหา: การตรวจสอบ PDF/A และ PDF/UA | ความล้มเหลวในการตรวจสอบเพื่อการจัดเก็บถาวรและการเข้าถึง |
| การแก้ไขปัญหา: ลายเซ็นและการประทับเวลา | ความล้มเหลวในการตรวจสอบลายเซ็นและการประทับเวลา |
ดูเพิ่มเติม
หัวข้อที่มีชื่อว่า “ดูเพิ่มเติม”- Cookbook (สูตรการใช้งาน) — สูตรตามงานที่คัดลอกไปใช้ได้สำหรับ PHP, Connect และการผสานการทำงาน
- ข้อมูลอ้างอิง — พื้นผิว API ที่ผ่านการตรวจสอบ ตารางการรองรับ และเอกสารอ้างอิงข้อผิดพลาด
- ย้ายมาใช้ NextPDF — การย้ายออกจากไลบรารี PDF อื่น ซึ่งอยู่ในแท็บเริ่มต้นใช้งาน
- ทำความเข้าใจ NextPDF เชิงลึก — บทความ Insider_ ที่อธิบายเหตุผลเบื้องหลังการทำงานของเอนจิน