แบบฝึกหัด - อัปเดต API ของเว็บด้วย GitHub Copilot

  • 5 นาที

ลองสำรวจวิธีที่คุณสามารถปรับเปลี่ยนที่เก็บ Python โดยใช้เทคนิค GitHub Copilot ขั้นสูงสำหรับจุดสิ้นสุด API รับประสบการณ์ที่ใช้งานได้จริงมากขึ้นโดยใช้ที่เก็บข้อมูลนี้ที่ประกอบด้วยเว็บแอปพลิเคชันของ Python ที่โฮสต์ Travel Weather API

API คืออะไร

API ทำหน้าที่เป็นตัวกลางที่ช่วยให้แอปพลิเคชันต่างๆ สามารถสื่อสารถึงกันได้ ตัวอย่างเช่น เว็บไซต์สภาพอากาศสามารถแบ่งปันข้อมูลในอดีตหรือจัดเตรียมฟังก์ชันการพยากรณ์ผ่าน API ได้ เมื่อใช้ API คุณสามารถฝังข้อมูลลงในเว็บไซต์ของคุณ หรือสร้างแอปพลิเคชันที่แชร์ข้อมูลสภาพอากาศกับฟีเจอร์อื่นๆ ได้

ขยาย API ของเว็บ

API ปัจจุบันไม่ได้เปิดเผยประเทศ/ภูมิภาค ซึ่งจําเป็นต้องนําไปใช้เพื่อแสดงรายการเมือง เส้นทางควรอนุญาตเฉพาะคําขอ GET HTTP ที่มีการตอบกลับ JSON ที่ให้ข้อมูลจากค่าสูงสุดและต่ําสุดในอดีตสําหรับประเทศ/ภูมิภาค เมือง และเดือนที่ระบุ

หมายเหตุ

สำหรับแบบฝึกหัดนี้ ให้ใช้ Codespace กับสภาพแวดล้อมที่กำหนดค่าไว้ล่วงหน้าในเบราว์เซอร์ของคุณ

ขั้นตอนที่ 1: เพิ่มเส้นทางใหม่

เปิดไฟล์ main.py และใช้การแชทแบบอินไลน์ด้วยคำสั่ง Ctrl + i (ใน Windows) หรือ Command + i (ใน Mac) คําสั่งนี้ขอให้ GitHub Copilot ช่วยคุณสร้าง API ใหม่ที่แสดงเมืองของประเทศ/ภูมิภาค ใช้พร้อมท์ต่อไปนี้:

Create a new route that exposes the cities of a country/region.

พร้อมท์นี้ควรมีลักษณะที่คล้ายคลึงกันดังนี้:

# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
    return list(data[country].keys())

หมายเหตุ

ลองใช้เส้นทางใหม่ของคุณและปรับแต่งพร้อมท์ของคุณจนกว่าจะได้รับผลลัพธ์ตามที่ต้องการ

ขั้นตอนที่ 2: สร้างการทดสอบ

เมื่อคุณสร้างเส้นทางใหม่แล้ว ให้สร้างการทดสอบด้วย Copilot Chat สําหรับเส้นทางนี้ที่ใช้สเปนเป็นประเทศ/ภูมิภาค อย่าลืมเลือกโค้ดของคุณ และขอให้ Copilot Chat ช่วยคุณด้วย API เฉพาะที่เราเพิ่งสร้างขึ้น คุณสามารถใช้การแชทแบบอินไลน์หรือบานหน้าต่างการแชทโดยเฉพาะร่วมกับพร้อมท์ต่อไปนี้ได้:

/tests help me to create a new test for this route that uses Spain as the country/region.

เมื่อ Copilot ช่วยคุณสร้างการทดสอบ ให้ลองดู หากแบบทดสอบนี้ไม่ได้ทำงานตามที่คาดหวังไว้ โปรดแบ่งปันรายละเอียดเหล่านั้นกับ Copilot ในการแชทได้เลย ตัวอย่างเช่น:

This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.

ขั้นตอนที่ 3: ใช้ตัวแทนเพื่อเขียนคู่มือการใช้

สุดท้าย ให้ใช้เอเจนต์ @workspace เพื่อเขียนคู่มือโครงการและรายละเอียดเกี่ยวกับวิธีการเรียกใช้โครงการเอง เปิดไฟล์ README.md และใช้พร้อมท์ต่อไปนี้ใน GitHub Copilot Chat:

@workspace I want to document how to run this project so that other developers can get started quickly by reading the README.md file.

คุณควรได้รับคำตอบที่ช่วยให้คุณอัปเดตไฟล์ README.md ด้วยข้อมูลที่จำเป็นในการดำเนินโครงการ

ขอแสดงความยินดีด้วยที่ทำแบบฝึกหัดนี้จนเสร็จสมบูรณ์ คุณใช้ GitHub Copilot เพื่อสร้างเส้นทาง API ใหม่ แล้วเขียนการทดสอบเพื่อตรวจสอบความถูกต้อง สุดท้าย คุณได้เพิ่มคู่มือโดยใช้เอเจนต์ที่จะช่วยให้นักพัฒนาเข้าใจวิธีเรียกใช้โครงการนี้

เมื่อคุณทำแบบฝึกหัดจนเสร็จสิ้นใน GitHub แล้ว ให้ย้อนกลับมายังที่นี่เพื่อรับ:

  • การประเมินความรู้อย่างรวดเร็ว
  • สรุปข้อมูลของสิ่งที่คุณได้เรียนรู้
  • ป้ายแจ้งสถานะสำหรับการศึกษามอดูลนี้จนเสร็จสมบูรณ์