Hızlı başlangıç: Developer Knowledge API'yi kullanmaya başlama

Bu kılavuzda, Developer Knowledge API'yi kullanmaya nasıl başlayacağınız gösterilmektedir. Bu eğitimde, Developer Knowledge API'yi etkinleştirmeyi, API anahtarı almayı ve geliştirici belgelerini arayıp almak için ilk API çağrılarınızı yapmayı öğreneceksiniz.

Başlamadan önce

API'yi etkinleştirme

  1. Google API'leri kitaplığında Developer Knowledge API sayfasını açın.
  2. API'yi kullanmayı planladığınız projeyi doğru seçtiğinizden emin olun.
  3. Etkinleştir'i tıklayın. API'yi etkinleştirmek veya kullanmak için belirli IAM rolleri gerekmez.

API anahtarını oluşturma ve güvenliğini sağlama

  1. API'yi etkinleştirdiğiniz projenin Google Cloud Console'unda Kimlik Bilgileri sayfasına gidin.
  2. Kimlik bilgileri oluştur'u tıklayın ve menüden API anahtarı'nı seçin.
  3. Ad alanında anahtar için bir ad girin.
  4. API kısıtlamalarını seçin açılır listesini tıklayın ve Developer Knowledge API yazın. Sonucu ve ardından Tamam'ı tıklayın.
    • Not: Developer Knowledge API'sini yeni etkinleştirdiyseniz listede görünmesi biraz zaman alabilir. Birkaç dakika bekleyip tekrar deneyin.
  5. Oluştur'u tıklayın.

Belge parçalarını arama

Developer Knowledge API anahtarınızı aldıktan sonra API'yi kullanmaya başlayabilirsiniz. Aşağıdaki örnekte, "BigQuery" ile ilgili belge parçalarının nasıl aranacağı gösterilmektedir:

  1. Developer Knowledge API anahtarınızı bir ortam değişkenine kaydedin:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    YOUR_API_KEY kısmını oluşturduğunuz API anahtarıyla değiştirin.

  2. curl uç noktasını aramak için searchDocumentChunks kullanın:

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Bu komut, sorguyla eşleşen belge parçalarının listesini döndürür. Bu listede, içerikteki snippet'ler ve her belge için bir parent yer alır.

Doküman alma

searchDocumentChunks yanıtı, belge parçalarının listesini içerir. Her belge parçası, parent alanına sahiptir. Bu alanı, GetDocument ile belgenin tam içeriğini almak için kullanabilirsiniz.

parent çağrısı tarafından döndürülen doküman parçalarından birinin searchDocumentChunks değerini (örneğin, documents/developers.google.com/...) kopyalayın, bir ortam değişkenine kaydedin ve GetDocument uç noktasını çağırmak için curl değerini kullanın:

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Bu işlev, belirtilen belgenin tam Markdown içeriğini döndürür.

Sırada ne var?