Latihan - Memperbarui API web dengan GitHub Copilot

  • 5 menit

Mari kita jelajahi bagaimana Anda dapat memodifikasi repositori Python menggunakan teknik GitHub Copilot tingkat lanjut untuk titik akhir API. Dapatkan pengalaman yang lebih praktis dengan menggunakan repositori ini yang berisi Aplikasi Web Python yang menghosting Travel Weather API.

Apa itu API?

API bertindak sebagai perantara yang memungkinkan aplikasi yang berbeda untuk berkomunikasi satu sama lain. Misalnya, situs web cuaca dapat berbagi data historis atau menyediakan fungsionalitas prakiraan melalui API-nya. Dengan menggunakan API, Anda dapat menyematkan data ke situs web Anda, atau membuat data cuaca berbagi aplikasi dengan fitur lain.

Memperluas API Web

API saat ini tidak mengekspos negara/wilayah, yang perlu diimplementasikan ke daftar kota. Rute hanya boleh mengizinkan permintaan HTTP GET dengan respons JSON yang memberikan informasi dari historis tinggi dan rendah untuk negara/wilayah, kota, dan bulan tertentu.

Catatan

Untuk latihan ini, gunakan Codespace dengan lingkungan yang telah dikonfigurasi sebelumnya di browser Anda.

Langkah 1: Tambahkan rute baru

Buka file main.py, dan gunakan obrolan sebaris dengan perintah Ctrl+i (di Windows) atau Command+i (di Mac). Perintah ini meminta GitHub Copilot untuk membantu Anda membuat API baru yang menunjukkan kota negara/wilayah. Gunakan perintah berikut:

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

Perintah ini akan memberi Anda sesuatu yang mirip seperti ini:

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

Catatan

Coba rute baru Anda dan perbaiki permintaan Anda hingga hasilnya sesuai keinginan.

Langkah 2: Membuat pengujian

Sekarang setelah Anda membuat rute baru, buat pengujian dengan Copilot Chat untuk rute ini yang menggunakan Spanyol sebagai negara/wilayah. Ingatlah untuk memilih kode Anda, dan minta Copilot Chat untuk membantu Anda dengan API khusus yang baru saja kami buat ini. Anda dapat menggunakan obrolan sebaris atau panel obrolan khusus dengan perintah berikut:

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

Setelah Copilot membantu Anda membuat pengujian, cobalah. Jika ini tidak berfungsi seperti yang diharapkan, jangan ragu untuk membagikan detail tersebut dengan Copilot di obrolan. Contohnya:

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

Langkah 3: Gunakan agen untuk menulis dokumentasi

Terakhir, gunakan @workspace agen untuk menulis dokumentasi proyek dan detail tentang cara menjalankan proyek itu sendiri. README.md Buka file dan gunakan perintah berikut di 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.

Anda harus mendapatkan respons yang membantu Anda memperbarui file README.md dengan informasi yang diperlukan untuk menjalankan proyek.

Selamat atas penyelesaian latihan ini. Anda menggunakan GitHub Copilot untuk menghasilkan rute API baru, lalu menulis pengujian untuk memverifikasi kebenarannya. Terakhir, Anda menambahkan dokumentasi menggunakan agen yang akan membantu pengembang memahami cara menjalankan proyek ini.

Setelah Anda menyelesaikan latihan di GitHub, kembali ke sini untuk:

  • Uji pengetahuan cepat
  • Ringkasan tentang apa yang telah Anda pelajari
  • Lencana untuk menyelesaikan modul ini