Alıştırma - GitHub Copilot ile web API'sini güncelleştirme

  • 5 dakika

Şimdi bir API uç noktası için gelişmiş GitHub Copilot tekniklerini kullanarak Python deposunu nasıl değiştirebileceğinizi keşfedelim. Seyahat Hava Durumu API'lerini barındıran bir Python Web Uygulaması içeren bu deposunu kullanarak daha pratik deneyimler elde edin.

API nedir?

API, farklı uygulamaların birbiriyle iletişim kurmasına olanak tanıyan aracı işlevi görür. Örneğin, bir hava durumu web sitesi api'si aracılığıyla geçmiş verileri paylaşabilir veya tahmin işlevselliği sağlayabilir. API'yi kullanarak verileri web sitenize ekleyebilir veya hava durumu verilerini diğer özelliklerle paylaşan bir uygulama oluşturabilirsiniz.

Web API'sini genişletme

Geçerli API, şehirleri listelemek için uygulanması gereken ülkeyi/bölgeyi açığa çıkarmaz. Yol yalnızca O ülke/bölge, şehir ve verilen ay için geçmiş yüksek ve düşük değerlerden bilgi sağlayan bir JSON yanıtına sahip GET HTTP isteklerine izin vermelidir.

Not

Bu alıştırma için Codespace'i tarayıcınızda önceden yapılandırılmış ortamla birlikte kullanın.

1. Adım: Yeni yol ekleme

main.py dosyasını açın ve Ctrl+i (Windows'da) veya Command+i (Mac'te) komutuyla satır içi sohbeti kullanın. Bu komut GitHub Copilot'tan bir ülkenin/bölgenin şehirlerini gösteren yeni bir API oluşturmanıza yardımcı olmasını ister. Aşağıdaki istemi kullanın:

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

Bu istem size şuna benzer bir şey vermelidir:

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

Not

Yeni rotanızı deneyin ve sonuç istenene kadar komutunuzu düzenleyin.

2. Adım: Test oluşturma

Yeni bir rota oluşturduğunuza göre, ülke/bölge olarak İspanya'yı kullanan bu rota için Copilot Chat ile bir test oluşturun. Kodunuzu seçmeyi unutmayın ve Copilot Chat'in yeni oluşturduğumuz bu API'de size yardımcı olmasını isteyin. Satır içi sohbeti veya ayrılmış sohbet bölmesini aşağıdaki istemle kullanabilirsiniz:

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

Copilot testinizi oluşturmanıza yardımcı olduktan sonra deneyin. Bu işlem beklendiği gibi çalışmıyorsa, bu ayrıntıları sohbette Copilot ile paylaşmaktan çekinmeyin. Örneğin:

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

3. Adım: Belgeleri yazmak için aracı kullanma

Son olarak GitHub Copilot Sohbet Aracısı modunu kullanarak proje belgelerini ve projenin kendisini çalıştırmayla ilgili ayrıntıları yazın. README.md Dosyayı açın ve GitHub Copilot Sohbeti'nde aşağıdaki istemi kullanın:

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 dosyasını projeyi çalıştırmak için gerekli bilgilerle güncelleştirmenize yardımcı olacak bir yanıt almanız gerekir.

Bu alıştırmayı tamamladýklarýnýz için tebrikler. GitHub Copilot kullanarak yeni bir API yolu oluşturup doğruluğunu doğrulamak için bir test yazdınız. Son olarak, geliştiricilerin bu projenin nasıl çalıştırılacağını anlamasına yardımcı olacak bir aracı kullanarak belgeler eklediniz.

GitHub'daki alıştırmayı bitirdiğinizde aşağıdakiler için buraya dönün:

  • Hızlı bir bilgi kontrolü
  • Öğrendiklerinizin bir özeti
  • Bu modülü tamamlamak için bir rozet