GSP164

Genel Bakış

Bu laboratuvarda, App Engine uygulamasında API oluşturmaya yönelik bir araç dizisi olan Google Cloud Endpoints ile örnek bir API dağıtacaksınız. Örnek kod şunları içerecek:

• Üç harften oluşan IATA kodundan (örneğin SFO, JFK, AMS) havaalanı adını sorgulayabileceğiniz bir REST API.
• API yapılandırmasını Cloud Endpoints'e yükleyen bir komut dosyası.
• Örnek API'yi barındırmak için esnek bir Google App Engine arka ucu dağıtan bir komut dosyası.

Örnek API'ye birkaç istek gönderdikten sonra Cloud Endpoints İşlem Grafikleri ve Günlükleri'ni görüntüleyebilirsiniz. Bunlar, API'lerinizi izlemenize ve kullanımlarına dair bilgi kazanmanıza imkan sağlayan araçlardır.

Kurulum ve şartlar

Laboratuvarı Başlat düğmesini tıklamadan önce

Buradaki talimatları okuyun. Laboratuvarlar süreli olduğundan duraklatılamaz. Laboratuvarı Başlat'ı tıkladığınızda başlayan zamanlayıcı, Google Cloud kaynaklarının ne süreyle kullanımınıza açık durumda kalacağını gösterir.

Bu uygulamalı laboratuvarı kullanarak, laboratuvar etkinliklerini gerçek bir bulut ortamında (Simülasyon veya demo ortamında değil.) gerçekleştirebilirsiniz. Bu olanağın sunulabilmesi için size yeni, geçici kimlik bilgileri verilir. Bu kimlik bilgilerini laboratuvar süresince Google Cloud'da oturum açmak ve Google Cloud'a erişmek için kullanırsınız.

Bu laboratuvarı tamamlamak için şunlar gerekir:

• Standart bir internet tarayıcısına erişim (Chrome Tarayıcı önerilir).

Not: Bu laboratuvarı çalıştırmak için tarayıcıyı gizli pencerede açın. Aksi takdirde, kişisel hesabınızla öğrenci hesabınız arasında oluşabilecek çakışmalar nedeniyle kişisel hesabınızdan ek ücret alınabilir.

• Laboratuvarı tamamlamak için yeterli süre. (Laboratuvarlar, başlatıldıktan sonra duraklatılamaz)

Not: Kişisel bir Google Cloud hesabınız veya projeniz varsa bu laboratuvarda kullanmayın. Aksi takdirde hesabınızdan ek ücret alınabilir.

Laboratuvarınızı başlatma ve Google Cloud Console'da oturum açma

1. Laboratuvarı Başlat düğmesini tıklayın. Laboratuvar için ödeme yapmanız gerekiyorsa ödeme yöntemini seçebileceğiniz bir pop-up açılır. Soldaki Laboratuvar Ayrıntıları panelinde şunlar yer alır:

   • Google Console'u Aç düğmesi
   • Kalan süre
   • Bu laboratuvarda kullanmanız gereken geçici kimlik bilgileri
   • Bu laboratuvarda ilerlemek için gerekebilecek diğer bilgiler

2. Google Console'u Aç'ı tıklayın. Laboratuvar, kaynakları çalıştırır ve sonra Oturum aç sayfasını gösteren başka bir sekme açar.

   İpucu: Sekmeleri ayrı pencerelerde, yan yana açın.

   Not: Hesap seçin iletişim kutusunu görürseniz Başka Bir Hesap Kullan'ı tıklayın.

3. Gerekirse Laboratuvar Ayrıntıları panelinden Kullanıcı adı'nı kopyalayın ve Oturum aç iletişim kutusuna yapıştırın. Sonraki'ni tıklayın.

4. Laboratuvar Ayrıntıları panelinden Şifre'yi kopyalayın ve Hoş geldiniz iletişim penceresine yapıştırın. Sonraki'ni tıklayın.

   Önemli: Sol paneldeki kimlik bilgilerini kullanmanız gerekir. Google Cloud Öğrenim Merkezi kimlik bilgilerinizi kullanmayın. Not: Bu laboratuvarda kendi Google Cloud hesabınızı kullanabilmek için ek ücret ödemeniz gerekebilir.

5. Sonraki sayfalarda ilgili düğmeleri tıklayarak ilerleyin:

   • Şartları ve koşulları kabul edin.
   • Geçici bir hesap kullandığınızdan kurtarma seçenekleri veya iki faktörlü kimlik doğrulama eklemeyin.
   • Ücretsiz denemelere kaydolmayın.

Birkaç saniye sonra Cloud Console bu sekmede açılır.

Not: Soldaki Gezinme menüsü'nü tıklayarak Google Cloud ürün ve hizmetlerinin listelendiği menüyü görüntüleyebilirsiniz.

Cloud Shell'i etkinleştirme

Cloud Shell, çok sayıda geliştirme aracı içeren bir sanal makinedir. 5 GB boyutunda kalıcı bir ana dizin sunar ve Google Cloud üzerinde çalışır. Cloud Shell, Google Cloud kaynaklarınıza komut satırı erişimi sağlar.

1. Google Cloud Console'un üst kısmından Cloud Shell'i etkinleştir simgesini tıklayın.

Bağlandığınızda, kimliğiniz doğrulanmış olur. Proje ise PROJECT_ID'nize göre ayarlanmıştır. Çıkış, bu oturum için PROJECT_ID'yi tanımlayan bir satır içerir:

Your Cloud Platform project in this session is set to YOUR_PROJECT_ID

gcloud, Google Cloud'un komut satırı aracıdır. Cloud Shell'e önceden yüklenmiştir ve sekmeyle tamamlamayı destekler.

2. (İsteğe bağlı) Etkin hesap adını şu komutla listeleyebilirsiniz:

gcloud auth list

3. Yetkilendir'i tıklayın.

4. Çıkışınız aşağıdaki gibi görünecektir:

Çıkış:

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`

5. (İsteğe bağlı) Proje kimliğini şu komutla listeleyebilirsiniz:

gcloud config list project

Çıkış:

[core] project = <project_ID>

Örnek çıkış:

[core] project = qwiklabs-gcp-44776a13dea667a6 Not: gcloud ile ilgili tüm belgeleri, Google Cloud'daki gcloud CLI'ya genel bakış rehberinde bulabilirsiniz.

1. görev: Örnek kodu alma

1. Örnek API'yi ve komut dosyalarını almak için Cloud Shell'de aşağıdaki komutu girin:

gsutil cp gs://spls/gsp164/endpoints-quickstart.zip . unzip endpoints-quickstart.zip

2. Örnek kodu içeren dizine geçiş yapın:

cd endpoints-quickstart

2. görev: Endpoints yapılandırmasını dağıtma

Endpoints'te REST API yayınlamak için API'yi açıklayan bir OpenAPI yapılandırma dosyası gereklidir. Laboratuvarın örnek API'si, openapi.yaml adlı önceden yapılandırılmış bir OpenAPI dosyasıyla birlikte gelir.

Endpoints, API'leri ve hizmetleri oluşturmak ve yönetmek için Google Cloud'un altyapı hizmeti olan Google Service Management'ı kullanır. API'leri Endpoints ile yönetmek için API'nin OpenAPI yapılandırmasını Service Management'a dağıtmanız gerekir.

Endpoints yapılandırmasını dağıtmak için:

1. endpoints-qwikstart dizininde aşağıdakileri girin:

cd scripts

2. Örnekte yer alan aşağıdaki komut dosyasını çalıştırın:

./deploy_api.sh

Cloud Endpoints, hizmeti belirlemek için OpenAPI yapılandırma dosyasındaki host alanını kullanır. deploy_api.sh komut dosyası, Cloud projenizin kimliğini host alanında yapılandırılan adın parçası olarak ayarlar. (Kendi hizmetiniz için bir OpenAPI yapılandırma dosyası hazırladığınızda bunu manuel olarak yapmanız gerekir.)

Komut dosyası daha sonra şu komutu kullanarak OpenAPI yapılandırmasını Service Management'a dağıtır: gcloud endpoints services deploy openapi.yaml

Service Management hizmeti oluşturur ve yapılandırırken konsolda bazı bilgilerin çıkışını sağlar. openapi.yaml yollarının API anahtarı gerektirmediğine ilişkin uyarıları rahatlıkla yoksayabilirsiniz. İşlem tamamlandığında, hizmet yapılandırma kimliğinin ve hizmet adının yer aldığı şöyle bir satır görürsünüz:

Service Configuration [2017-02-13-r2] uploaded for service [airports-api.endpoints.example-project.cloud.goog]

Hedefi doğrulamak için İlerleme durumumu kontrol et'i tıklayın. Endpoints yapılandırması dağıtılıyor.

3. görev: API arka ucunu dağıtma

Şu ana kadar OpenAPI yapılandırmasını Service Management'a dağıttınız ancak henüz API arka ucunu sunacak kodu dağıtmadınız. Laboratuvar örneğinde bulunan deploy_app.sh komut dosyası, API arka ucunu barındırmak için esnek bir App Engine ortamı oluşturur ve daha sonra komut dosyası API'yi App Engine'e dağıtır.

• API arka ucunu dağıtmak için endpoints-quickstart/scripts dizininde olduğunuzdan emin olun. Ardından, aşağıdaki komut dosyasını çalıştırın:

./deploy_app.sh

Komut dosyası, bölgesinde App Engine esnek ortamı oluşturmak için şu komutu çalıştırır: gcloud app create --region="$REGION"

App Engine esnek arka ucunun oluşturulması birkaç dakika sürer.

Not: ERROR: NOT_FOUND: Unable to retrieve P4SA: from GAIA mesajını alırsanız deploy_app.sh komut dosyasını tekrar çalıştırın.

App Engine oluşturulduktan sonra Cloud Shell'de aşağıdakiler gösterilir:

Success! The app is now created. Please use `gcloud app deploy` to deploy your first app.

Komut dosyası, örnek API'yi App Engine'e dağıtmak için gcloud app deploy komutunu çalıştırmak üzere çalışmaya devam eder.

Ardından, Cloud Shell'de aşağıdakine benzer bir satır görürsünüz:

Deploying ../app/app_template.yaml...You are about to deploy the following services:

API'nin App Engine'e dağıtılması birkaç dakika sürer. API, App Engine'e dağıtıldıktan sonra aşağıdakine benzer bir satır görürsünüz:

Deployed service [default] to [https://example-project.appspot.com]

Hedefi doğrulamak için İlerleme durumumu kontrol et'i tıklayın. API arka ucu dağıtılıyor.

4. görev: API'ye istek gönderme

1. Örnek API'yi dağıttıktan sonra aşağıdaki komut dosyasını çalıştırarak API'ye istek gönderebilirsiniz:

./query_api.sh

Komut dosyası, API'ye istek göndermek için kullandığı curl komutunu tekrarlar, ardından sonucu gösterir. Cloud Shell'de aşağıdakine benzer bir sonuç görürsünüz:

curl "https://example-project.appspot.com/airportName?iataCode=SFO" San Francisco International Airport

API; SEA veya JFK gibi geçerli bir IATA havaalanı koduna ayarlanmış bir sorgu parametresi (iataCode) bekler.

2. Test etmek için Cloud Shell'de şu örneği çalıştırın:

./query_api.sh JFK

Cloud Endpoints'te API dağıttınız ve bu API'yi test ettiniz.

Hedefi doğrulamak için İlerleme durumumu kontrol et'i tıklayın. İstekler API'ye gönderiliyor.

5. görev: API etkinliğini izleme

Cloud Endpoints yoluyla dağıtılan API'ler sayesinde, hem kritik işlem metriklerini Cloud Console'da izleyebilir hem de Cloud Logging'den yararlanarak kullanıcılarınız ve kullanım hakkında bilgi edinebilirsiniz.

1. Grafikleri ve günlükleri doldurmak için Cloud Shell'de şu trafik oluşturma komut dosyasını çalıştırın.

./generate_traffic.sh Not: Bu komut dosyası, istekleri döngü hâlinde oluşturur ve 5 dakika içinde otomatik olarak zaman aşımına uğrar. Komut dosyasını daha erken sonlandırmak için Cloud Shell'de Ctrl-C tuşlarına basın.

2. Console'da, hizmetinizin işlem grafiklerine bakmak için Gezinme menüsü > Endpoints > Services (Hizmetler)'e gidin ve Airport Codes (Havaalanı Kodları) hizmetini tıklayın. İsteklerin grafiklere yansıtılması birkaç dakika sürebilir Verilerin görüntülenmesini beklerken şunu yapabilirsiniz:

• İzinler yan paneli açık değilse Show Permissions Panel'i (İzinler Panelini Göster) tıklayın. İzinler paneli, API'nize kimlerin erişebileceğini ve bu kişilerin erişim düzeyini kontrol etmenizi sağlar.

• Deployment history (Dağıtım geçmişi) sekmesini tıklayın. Bu sekme, dağıtım zamanı ve değişikliğin kim tarafından dağıtıldığı da dahil olmak üzere API dağıtımlarınızın geçmişini görüntüler.

• Overview (Genel bakış) sekmesini tıklayın. Burada, trafiğin geldiğini göreceksiniz. Trafik oluşturma komut dosyası bir dakika boyunca çalıştıktan sonra, Total latency (Toplam gecikme) grafiğindeki üç satırı (50., 95. ve 99. yüzdelik dilimler) görmek üzere aşağı kaydırın. Bu veriler, yanıt sürelerinin tahmini değerini hızlıca belirler.

3. Endpoints grafiklerinin alt kısmında bulunan Yöntem'in altında GET/airportName için View logs (Günlükleri göster) bağlantısını tıklayın. Logs Viewer (Günlük Görüntüleyici) sayfası, API'nin istek günlüklerini görüntüler.

4. Komut dosyasını durdurmak için Cloud Shell'de Ctrl-C tuşlarına basın.

6. görev: API'ye kota ekleme

Not: Bu, kotalar özelliğinin beta sürümüdür. Bu özellik, eski sürümlerle uyumsuz olacak şekilde değiştirilebilir. Herhangi bir HDS'ye (Hizmet Düzeyi Sözleşmesi) veya kullanımdan kaldırma politikasına tabi değildir.

Cloud Endpoints, uygulamaların API'nize çağrı yapma hızını kontrol edebilmeniz için kotalar ayarlamanızı sağlar. Kotalar, API'nizi tek bir istemcinin aşırı kullanımından korumak için kullanılabilir.

1. Kotası olan bir Endpoints yapılandırması dağıtın:

   ./deploy_api.sh ../openapi_with_ratelimit.yaml

2. Uygulamanızı, yeni Endpoints yapılandırmasını kullanacak şekilde yeniden dağıtın (Bu işlem birkaç dakika sürebilir.):

   ./deploy_app.sh

   Hedefi doğrulamak için İlerleme durumumu kontrol et'i tıklayın. API'ye kota ekleyin.

3. Console'da Gezinme menüsü > APIs & Services (API'ler ve Hizmetler) > Credentials'a (Kimlik bilgileri) gidin.

4. Create credentials'ı (Kimlik bilgileri oluştur) tıklayın ve API key'i (API anahtarı) seçin. Ekranda yeni bir API anahtarı görüntülenir.

5. Anahtarı panonuza kopyalamak için Copy to clipboard (Panoya kopyala) simgesini tıklayın.

6. Cloud Shell'de aşağıdakileri yazın. YOUR-API-KEY kısmını az önce oluşturduğunuz API ile değiştirin:

   export API_KEY=YOUR-API-KEY

7. Oluşturduğunuz API anahtarı değişkeniyle, API'nize bir istek gönderin:

   ./query_api_with_key.sh $API_KEY

   Console'da şuna benzer bir çıkış görürsünüz:

   curl -H 'x-api-key: AIzeSyDbdQdaSdhPMdiAuddd_FALbY7JevoMzAB' "https://example-project.appspot.com/airportName?iataCode=SFO" San Francisco International Airport

8. API'nin, saniye başına istek sayısı için sınırı 5 olarak ayarlandı. API'ye trafik göndermek ve kota sınırını tetiklemek için aşağıdaki komutu çalıştırın:

   ./generate_traffic_with_key.sh $API_KEY

9. Komut dosyasını 5-10 saniye boyunca çalıştırdıktan sonra, durdurmak için Cloud Shell'de Ctrl-C tuşlarına basın.

10. API'ye kimliği doğrulanmış başka bir istek gönderin:

    ./query_api_with_key.sh $API_KEY

    Console'da şuna benzer bir çıkış görürsünüz:

{ "code": 8, "message": "Insufficient tokens for quota 'airport_requests' and limit 'limit-on-airport-requests' of service 'example-project.appspot.com' for consumer 'api_key:AIzeSyDbdQdaSdhPMdiAuddd_FALbY7JevoMzAB'.", "details": [ { "@type": "type.googleapis.com/google.rpc.DebugInfo", "stackEntries": [], "detail": "internal" } ] }

Farklı bir yanıt alırsanız generate_traffic_with_key.sh komut dosyasını yeniden çalıştırmayı deneyin ve baştan başlayın.

Hedefi doğrulamak için İlerleme durumumu kontrol et'i tıklayın. İstekler göndererek API anahtarı ve test kotası sınırı oluşturun.

Tebrikler!

Tebrikler! API'nize başarıyla hız sınırlaması uyguladınız. Ayrıca farklı API yöntemlerinde çeşitli sınırlar ayarlayabilir, birden çok türde kota oluşturabilir ve hangi tüketicilerin hangi API'leri kullandığını takip edebilirsiniz.

Sonraki laboratuvarınıza katılın

Bu laboratuvar, Qwik Starts laboratuvar serisinin bir parçasıdır. Bu laboratuvarlar, Google Cloud'daki pek çok özelliği biraz olsun tanıtabilmek için tasarlamıştır. Katılmak istediğiniz bir sonraki laboratuvarı bulmak için laboratuvar kataloğuna “Qwik Starts” yazın.

Sonraki adımlar/Daha fazla bilgi

Kotalar hakkında daha fazla bilgi için aşağıdakilere bakın:

• OpenAPI için Kotalar
• Endpoints Çerçeveleri için Kotalar
• gRPC için Kotalar

Google Cloud eğitimi ve sertifikası

...Google Cloud teknolojilerinden en iyi şekilde yararlanmanıza yardımcı olur. Derslerimizde teknik becerilere odaklanırken en iyi uygulamalara da yer veriyoruz. Gerekli yetkinlik seviyesine hızlıca ulaşmanız ve öğrenim maceranızı sürdürebilmeniz için sizlere yardımcı olmayı amaçlıyoruz. Temel kavramlardan ileri seviyeye kadar farklı eğitim programlarımız mevcut. Ayrıca, yoğun gündeminize uyması için talep üzerine sağlanan, canlı ve sanal eğitim alternatiflerimiz de var. Sertifikasyonlar ise Google Cloud teknolojilerindeki becerilerinizi ve uzmanlığınızı doğrulamanıza ve kanıtlamanıza yardımcı oluyor.

Kılavuzun son güncellenme tarihi: 22 Kasım 2023

Laboratuvarın son test edilme tarihi: 22 Kasım 2023

Telif Hakkı 2024 Google LLC Tüm hakları saklıdır. Google ve Google logosu, Google LLC şirketinin ticari markalarıdır. Diğer tüm şirket ve ürün adları ilişkili oldukları şirketlerin ticari markaları olabilir.