สารบัญ:
มันเป็นธรรมชาติของการพัฒนาซอฟต์แวร์ นักพัฒนาสร้างซอฟต์แวร์โดยคำนึงถึงผู้ใช้ปลายทาง ดูเหมือนจะค่อนข้างง่าย แต่บางครั้งผู้ใช้เหล่านั้นก็เป็นนักพัฒนาซอฟต์แวร์ด้วยเช่นกัน พวกเขาไม่ต้องการสิ่งต่าง ๆ สำหรับพวกเขา พวกเขาไม่ต้องการแม้แต่ต้องการความเรียบง่าย สิ่งที่พวกเขาต้องการคือการเข้าถึง - วิธีรวมซอฟต์แวร์ของคุณเข้ากับซอฟต์แวร์ของพวกเขา นี่คือที่ที่ API (อินเทอร์เฟซการเขียนโปรแกรมประยุกต์) เข้ามาฉันหวังว่าจะเน้นห้าขั้นตอนที่คุณสามารถทำได้เพื่อสร้าง API ที่ประสบความสำเร็จ
ทำการบ้านของคุณ
เมื่อพูดถึงการพัฒนาซอฟต์แวร์พวกเราไม่มีใครต้องการคิดค้นล้อ ณ จุดนี้ บริษัท เว็บขนาดใหญ่เกือบทั้งหมดมี API สำหรับผลิตภัณฑ์ซอฟต์แวร์ของพวกเขา ศึกษา API เหล่านี้และลองตัดสินใจเลือกการออกแบบที่แตกต่างกันเพื่อสร้างมันขึ้นมา
มีเทคโนโลยีที่แตกต่างกันออกไป แต่ API ส่วนใหญ่ที่คุณเห็นจะใช้อินเทอร์เฟซ RESTful หรือ SOAP หากคุณอยู่ในกรอบที่คุณต้องการใช้ส่วนต่อประสาน API ฉันขอแนะนำให้ใช้วิธีการสงบใหม่โดยใช้โปรโตคอล HTTP มันง่ายกว่า SOAP ปัจจุบันเป็นที่นิยมมากขึ้นและจะเริ่มต้นได้ง่ายขึ้นเมื่อใช้ผลิตภัณฑ์ซอฟต์แวร์บนเว็บ
คงเส้นคงวา
หนึ่งในสิ่งที่นักพัฒนาชื่นชมมากที่สุดคือความสอดคล้อง ซึ่งรวมถึงสิ่งอื่น ๆ ความสามารถจัดการแอดเดรสอาร์กิวเมนต์อินพุตรูปแบบเอาต์พุตและการจัดการข้อผิดพลาด
เมื่อใช้วิธี RESTful จะมีรูปแบบการตั้งชื่อ URI ที่แตกต่างกันมากมาย แต่ละคนมีผู้สนับสนุนดังนั้นเพียงแค่เลือกหนึ่งตัวและยึดติดกับมัน เช่นเดียวกันกับโครงสร้างอินพุตและเอาต์พุต APIs ส่วนใหญ่รองรับการใช้ XML และ JSON เป็นรูปแบบอินพุตและเอาต์พุต ฉันขอแนะนำให้สนับสนุนทั้งสอง แต่เลือกรูปแบบเริ่มต้น
สำหรับการป้อนข้อมูลข้อกำหนดการป้อนข้อมูลของคุณควรตั้งชื่ออย่างสม่ำเสมอและควรสมเหตุสมผลในบริบทของการเรียก API ที่คุณกำลังทำ สำหรับผลลัพธ์ตรวจสอบให้แน่ใจว่าคุณใช้โครงร่างโครงสร้างข้อมูลทั่วไป หากคุณกำลังตัดเอาต์พุตของการโทร API หนึ่งรายการใน
เป็นวิธีปฏิบัติทั่วไปที่จะรวมการตั้งค่าสถานะบางอย่างในข้อมูลผลลัพธ์ที่คุณส่งกลับไปยังไคลเอนต์ เมื่อใช้วิธี RESTful API สิ่งนี้ควรทำโดยใช้รหัสสถานะ HTTP ตัวอย่างเช่นหากคุณเพิ่งประมวลผลคำขอ PUT บนวัตถุข้อมูลที่มีอยู่รหัสสถานะ HTTP ที่คุณรวมไว้ในการตอบกลับของคุณจะแตกต่างกันไปขึ้นอยู่กับผลลัพธ์ของคำขอ
แทนที่จะใช้การตั้งค่าสถานะที่ระบุสถานะของการโทรสามารถใช้รหัสสถานะมาตรฐาน "200 OK" เพื่อแสดงว่าคำขอสำเร็จในขณะที่สามารถใช้รหัสสถานะ "400 คำขอไม่ถูกต้อง" เพื่อแสดงว่าคำขอนั้นเป็น ไม่สมประกอบ มีรหัสสถานะ HTTP ค่อนข้างน้อยที่สามารถใช้ได้ในสถานการณ์ที่แตกต่างกัน
ใช้ OAuth
ผลิตภัณฑ์ซอฟต์แวร์ส่วนใหญ่จะเกี่ยวข้องกับการตรวจสอบผู้ใช้บางประเภทเพื่อเข้าถึงทรัพยากรที่มีการป้องกันสำหรับผู้ใช้รายนั้น เมื่อพูดถึง API การมีไคลเอนต์เก็บรวบรวมข้อมูลประจำตัวผู้ใช้เพื่อส่งไปยังเซิร์ฟเวอร์ของคุณเป็นวิธีปฏิบัติที่ไม่ดี นี่คือที่ OAuth เข้ามา
OAuth มอบประโยชน์มากมายผ่านการตรวจสอบชื่อผู้ใช้ / รหัสผ่านของบุคคลที่สาม เหนือสิ่งอื่นใดลูกค้าไม่สามารถเข้าถึงข้อมูลรับรองของผู้ใช้ได้ ผู้ใช้จะถูกเปลี่ยนเส้นทางไปยังเซิร์ฟเวอร์ของคุณเมื่อเขาหรือเธอเข้าสู่ระบบหลังจากที่ผู้ใช้เข้าสู่เว็บไซต์ของคุณเขาหรือเธอจะถูกเปลี่ยนเส้นทางกลับไปยังลูกค้าที่ลูกค้าจะได้รับโทเค็นการเข้าถึงเพื่อใช้ในการร้องขอในอนาคต
ประโยชน์ที่สำคัญอีกประการหนึ่งของการใช้ OAuth คือความสามารถของผู้ใช้ในการยกเลิกการเข้าถึงไคลเอ็นต์ได้ตลอดเวลา หากผู้ใช้ตัดสินใจเช่นนั้นไม่ว่าด้วยเหตุผลใดพวกเขาไม่ต้องการให้ลูกค้าสามารถเข้าถึงทรัพยากรที่มีการป้องกันในนามของพวกเขาพวกเขาเพียงแค่ไปที่อินเทอร์เฟซที่คุณสร้างขึ้นและยกเลิกการเข้าถึงของลูกค้า
เริ่มก่อน
หนึ่งในสิ่งที่สำคัญที่สุดที่คุณสามารถทำได้เพื่อทำให้ API ของคุณประสบความสำเร็จคือการเริ่มต้น เมื่อคุณเขียนฟังก์ชั่นนั้นเพื่อสร้างบางรายการในฐานข้อมูลของคุณไปข้างหน้าและใช้เวลาเพิ่มเติมและเขียนอินเทอร์เฟซ APIเขียนเอกสารที่ดี
ไม่มีอะไรที่จะฆ่า API ได้เร็วกว่าการไม่มีเอกสารที่ดี ในขณะที่นักพัฒนาบางคนสามารถใช้ API ที่มีเอกสารไม่ดีและเข้าใจว่ามันควรจะทำงานอย่างไรส่วนใหญ่ก็ไม่ต้องการ
คุณควรบันทึกการเรียกใช้ API ทุกครั้งที่คุณมีอยู่และจัดหมวดหมู่การโทร API ของคุณตามประเภทของข้อมูลที่พวกเขาดำเนินการ นอกเหนือจากการบันทึกจุดสิ้นสุดสำหรับการเรียก API เองคุณควรกำหนดอาร์กิวเมนต์อินพุตที่จำเป็นและเป็นทางเลือกเช่นเดียวกับโครงสร้างข้อมูลเอาต์พุต อาร์กิวเมนต์ที่ป้อนเข้าควรแสดงรายการค่าเริ่มต้นถ้ามีและระบุรูปแบบข้อมูลที่คาดไว้เช่นตัวเลขหรือสตริง สุดท้ายการเรียกใช้ API ทุกครั้งควรมีรายการเงื่อนไขข้อผิดพลาดและรหัสสถานะ
หากต้องการปัดเศษเอกสารของคุณให้แน่ใจว่าได้รวมตัวอย่างหนึ่งหรือสองตัวอย่างสำหรับสถานการณ์อินพุตและเอาต์พุตทั่วไปสำหรับการเรียก API แต่ละครั้ง
การพัฒนา API: ทำให้ง่ายขึ้น
แม้ว่ามันอาจดูเหมือนว่าการพัฒนา API นั้นเป็นความพยายามที่ซับซ้อน แต่ความคิดของ API นั้นไม่ใช่แนวคิดใหม่และมีเอกสารจำนวนมากในแต่ละหัวข้อที่เราสัมผัสที่นี่ เพียงให้แน่ใจว่าใช้แนวทางปฏิบัติที่ดีที่คุณสามารถค้นหาได้และเพื่อให้อินเทอร์เฟซที่สอดคล้องและมีเอกสารที่ดี
