ApiDoc

การแนะนำ

APIDOC เป็นเทมเพลตที่ทำใน HTML, PHP และ jQuery เพื่อช่วยในเอกสาร PHP REST API

การติดตั้ง

คัดลอกลิงค์ด้านล่างไปยังบรรทัดคำสั่งของคุณเพื่อดาวน์โหลดเวอร์ชันล่าสุด APIDOC ไม่จำเป็นต้องติดตั้งบนเครื่องของคุณเพียงแค่โคลนไฟล์และคลายซิปลงในโฟลเดอร์เซิร์ฟเวอร์

$ git clone -b 2.0.0-stable --single-branch https://github.com/brennoDuarte/ApiDoc.git ApiDoc-v2.0.0-stable

ตรวจสอบให้แน่ใจว่า JavaScript เปิดใช้งานในเบราว์เซอร์ของคุณ คุณสามารถเปิดโหมดมืด แต่มันจะปิดทันทีที่คุณโหลดหน้าใหม่

กำหนดค่า

ไฟล์ JSON อยู่ในโฟลเดอร์ "JSON"

คุณสามารถแก้ไขไฟล์ "config.json" ได้ดังนี้:

• "AppName" : ชื่อโครงการของคุณ
• "เวอร์ชัน" : เวอร์ชันโครงการของคุณ
• "คำอธิบาย" : คำอธิบายสั้น ๆ ของ API ของคุณ
• "ภาษา" : ภาษาที่ API ของคุณสร้างขึ้น
• "Protocol" : โปรโตคอล API ของคุณ HTTP หรือ HTTPS

หากต้องการแก้ไขเส้นทางเริ่มต้นให้เปลี่ยนไฟล์ "router.json" เซสชัน URL ถูกแบ่งออกเป็น:

• "PathName" : ชื่อเส้นทางหลักจากจุดสิ้นสุดของคุณ
• "ID" : Modal ID ที่จะแสดงโดยคลิกที่ปุ่มเส้นทาง อย่าลืมแก้ไข ID ที่แตกต่างกันสำหรับแต่ละจุดสิ้นสุดไม่เช่นนั้น ID จะไม่ปรากฏขึ้น
• "Pathget/getId/post/put/delete" : จุดสิ้นสุดของ API ของคุณ
• "Descriptionget/post/put/delete" : คำอธิบายสั้น ๆ เกี่ยวกับจุดสิ้นสุดของคุณ
• "ลิงก์" : ลิงก์จากจุดสิ้นสุดของคุณ การคลิกมันจะเปิดในแท็บใหม่

ในการเพิ่มพา ธ ใหม่ให้คัดลอกจาก "ชื่อพาวเวอร์" ลงในไฟล์ "config.json" และวางไว้ด้านล่างเส้นทางอื่น ๆ

หากคุณมีหลายเส้นทาง (รับโพสต์ใส่ลบ) ใช้เส้นทางที่กำหนดเอง คุณสามารถแก้ไขไฟล์ customrouter.json สำหรับสิ่งนี้:

• "CustomRouter" : ชื่อเส้นทางหลักจากจุดสิ้นสุดของคุณ
• "พิมพ์" : รับโพสต์ใส่ลบหรืออื่น ๆ
• "เส้นทาง" : จุดสิ้นสุดของ API ของคุณ
• "คำอธิบาย" : คำอธิบายสั้น ๆ เกี่ยวกับจุดสิ้นสุดของคุณ
• "ลิงก์" : ลิงก์จากจุดสิ้นสุดของคุณ การคลิกมันจะเปิดในแท็บใหม่

หาก API ของคุณไม่มีคำขอบางอย่างให้เปลี่ยนฟิลด์เป็น NULL ตัวอย่าง:

 " post " : {
    " id " : null,
    " pathPost " : null,
    " descriptionPost " : null,
    " link " : null
},

เสร็จแล้วเพียงเปิดไฟล์ apidoc.php ในการเรียกดูใด ๆ