Latihan - Memperbarui API web Python dengan GitHub Copilot

  • 5 menit

Mari kita jelajahi bagaimana Anda dapat memodifikasi repositori Python menggunakan saran kode dari GitHub Copilot untuk membuat formulir HTML interaktif dan titik akhir Application Programming Interface (API). Dengan bekerja dengan repositori ini, Anda dengan cepat mendapatkan langsung dengan aplikasi web Python yang melayani API HTTP yang menghasilkan token pseudo-random, yang umumnya digunakan dalam rutinitas identifikasi.

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 sudah memiliki satu titik akhir untuk menghasilkan token. Mari kita perbarui API dengan menambahkan titik akhir baru yang menerima teks dan mengembalikan daftar token.

Catatan

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

Langkah 1: Menambahkan model Pydantic

main.py Buka file, dan tambahkan komentar sehingga GitHub Copilot dapat menghasilkan Pydantic model untuk Anda. Model yang dihasilkan akan terlihat seperti contoh ini:

class Text(BaseModel):

text: str

Langkah 2: Hasilkan titik akhir baru

Selanjutnya, buat titik akhir baru dengan GitHub Copilot dengan menambahkan komentar:

# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text

Langkah 3: Tambahkan impor yang diperlukan

Kode yang dihasilkan dapat menyebabkan aplikasi mengalami crash jika base64 modul dan os tidak diimpor. Gunakan GitHub Copilot Chat untuk meminta Copilot untuk membantu Anda menambahkan impor yang hilang.

Atau, tambahkan baris berikut ke bagian atas file:

import base64
import os

Terakhir, verifikasi titik akhir baru berfungsi. Cobalah dengan masuk ke /docs titik akhir dan mengonfirmasi bahwa titik akhir muncul.

Selamat, melalui latihan, Anda tidak hanya menggunakan Copilot untuk menghasilkan kode, tetapi Anda juga melakukannya dengan cara interaktif dan menyenangkan! Anda dapat menggunakan GitHub Copilot untuk menghasilkan kode, menulis dokumentasi, menguji aplikasi Anda, dan banyak lagi.

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

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