Krótkie wprowadzenie: korzystanie z interfejsu Developer Knowledge API

Z tego przewodnika dowiesz się, jak zacząć korzystać z interfejsu Developer Knowledge API. Dowiesz się, jak włączyć interfejs Developer Knowledge API, uzyskać klucz API i wykonać pierwsze wywołania interfejsu API, aby wyszukiwać i pobierać dokumentację dla programistów.

Zanim zaczniesz

Włącz API

  1. Otwórz stronę interfejsu Developer Knowledge API w bibliotece interfejsów API Google.
  2. Sprawdź, czy masz wybrany odpowiedni projekt, w którym zamierzasz używać interfejsu API.
  3. Kliknij Włącz. Do włączenia i korzystania z interfejsu API nie są wymagane żadne konkretne role uprawnień.

Tworzenie i zabezpieczanie klucza interfejsu API

  1. W konsoli Google Cloud w projekcie, w którym został włączony interfejs API, otwórz stronę Dane logowania.
  2. Kliknij Utwórz dane logowania, a potem w menu wybierz Klucz interfejsu API.
  3. W polu Nazwa podaj nazwę klucza.
  4. Kliknij menu Wybierz ograniczenia interfejsu API, a następnie wpisz Developer Knowledge API. Kliknij wynik, a następnie kliknij OK.
    • Uwaga: jeśli interfejs Developer Knowledge API został dopiero włączony, może minąć trochę czasu, zanim pojawi się na liście. Poczekaj kilka minut i spróbuj ponownie.
  5. Kliknij Utwórz.

Wyszukiwanie fragmentów dokumentów

Gdy uzyskasz klucz interfejsu Developer Knowledge API, możesz zacząć korzystać z tego interfejsu. Poniższy przykład pokazuje, jak wyszukać fragmenty dokumentów powiązane z „BigQuery”:

  1. Zapisz klucz interfejsu Developer Knowledge API w zmiennej środowiskowej:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Zastąp YOUR_API_KEY wygenerowanym kluczem interfejsu API.

  2. Użyj curl, aby wywołać punkt końcowy searchDocumentChunks:

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

To polecenie zwraca listę fragmentów dokumentów pasujących do zapytania, w tym fragmenty treści i parent dla każdego dokumentu.

Pobieranie dokumentu

Odpowiedź z searchDocumentChunks zawiera listę fragmentów dokumentu. Każdy fragment dokumentu ma pole parent, którego możesz użyć do pobrania pełnej treści dokumentu za pomocą GetDocument.

Skopiuj parent jednego z fragmentów dokumentu zwróconych przez wywołanie searchDocumentChunks (np. documents/developers.google.com/...), zapisz go w zmiennej środowiskowej i użyj curl, aby wywołać punkt końcowy GetDocument:

export DOC_NAME="DOCUMENT_NAME"

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

Zwraca pełną zawartość Markdown określonego dokumentu.

Co dalej?