Mulai menggunakan Framework Cloud Endpoints untuk Python

Halaman ini menunjukkan cara mengonfigurasi, men-deploy, dan mengirim permintaan ke contoh API dengan menggunakan Cloud Endpoints Frameworks for Python. Endpoints Frameworks untuk Python terintegrasi dengan lingkungan runtime Python 2.7 standar App Engine. Framework Endpoints terdiri dari alat, library, dan kemampuan yang memungkinkan Anda membuat API dan library klien dari aplikasi App Engine.

Tujuan

Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial ini. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.

  1. Siapkan Google Cloud project. Lihat Sebelum memulai.
  2. Instal software yang diperlukan dan buat aplikasi App Engine. Lihat Menginstal dan mengonfigurasi software yang diperlukan.
  3. Download kode contoh. Lihat Mendapatkan kode contoh.
  4. Buat dokumen OpenAPI. Lihat Mengonfigurasi Endpoint.
  5. Deploy konfigurasi Endpoints untuk membuat layanan Endpoints. Lihat Men-deploy konfigurasi Endpoints.
  6. Jalankan sampel di komputer Anda. Lihat Menjalankan contoh secara lokal.
  7. Buat backend untuk menayangkan API dan men-deploy API. Lihat Men-deploy backend API.
  8. Kirim permintaan ke API. Lihat Mengirim permintaan ke API.
  9. Melacak aktivitas API. Lihat Melacak aktivitas API.
  10. Hindari menimbulkan tagihan ke akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna Google Cloud baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Sebelum memulai

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Catat ID project Google Cloud karena akan diperlukan nanti.

    7. Menginstal dan mengonfigurasi software yang diperlukan

    1. Ikuti petunjuk di Menginstal Google Cloud CLI untuk Python guna menyiapkan lingkungan pengembangan standar App Engine. Pastikan Anda menginstal komponen app-engine-python dan app-engine-python-extras gcloud.
    2. Jalankan perintah berikut:
      1. Update gcloud CLI. 
        gcloud components update
      2. Pastikan Google Cloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud: 
        gcloud auth login
      3. Di tab browser baru yang terbuka, pilih akun.
      4. Tetapkan project default ke project ID Anda. 
        gcloud config set project [YOUR_PROJECT_ID]

        Ganti [YOUR_PROJECT_ID] dengan Google Cloud project ID Anda. Jika Anda memiliki project Google Cloud lain, dan Anda ingin menggunakan gcloud untuk mengelolanya, lihat Mengelola konfigurasi gcloud CLI.

    3. Anda memerlukan aplikasi untuk mengirim permintaan ke contoh API.

      • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika Anda belum memiliki curl, Anda dapat mendownloadnya dari curl Halaman rilis dan download.
      • Pengguna Windows: Tutorial ini memberikan contoh penggunaan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.
    4. Pastikan lingkungan pengembangan Python Anda menyertakan pip.
    5. Pastikan Anda dapat mengompilasi ekstensi C untuk Python.
      • Windows: Microsoft Visual C++ 9.0 atau yang lebih baru diperlukan. Anda dapat mendownload Microsoft Visual C++ Compiler untuk Python 2.7 dari Pusat Download Microsoft .
      • Sistem operasi lain: Bergantung pada sistem operasi Anda, Anda mungkin perlu menginstal alat compiler (terkadang dalam paket yang disebut build-essential) atau header pengembangan Python (terkadang dalam paket yang disebut python-dev).

    6. Untuk Linux, tetapkan variabel lingkungan ENDPOINTS_GAE_SDK ke jalur folder App Engine SDK Anda: [Path-to-Google-Cloud-SDK]/platform/google_appengine.

      Ganti [Path-to-Google-Cloud-SDK] dengan output dari perintah berikut: 

      gcloud info --format="value(installation.sdk_root)"

    7. Buat aplikasi App Engine:
      1. Pilih region tempat Anda ingin membuat aplikasi App Engine. Jalankan perintah berikut untuk mendapatkan daftar region: 
        gcloud app regions list
      2. Buat aplikasi App Engine menggunakan perintah berikut. Ganti [YOUR_PROJECT_ID] dengan Google Cloud project ID Anda dan [YOUR_REGION] dengan region tempat Anda ingin aplikasi App Engine dibuat. 
        gcloud app create \
--project=[YOUR_PROJECT_ID] \
--region=[YOUR_REGION]

        Contoh:

        gcloud app create --project=example-project-12345 --region=us-central

Mendapatkan kode contoh

Untuk meng-clone contoh API dari GitHub:

  1. Clone repositori contoh ke komputer lokal Anda:

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

  2. Ubah ke direktori yang berisi kode contoh:

    cd python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo

Mengonfigurasi Endpoint

Untuk mengonfigurasi Endpoints, Anda harus menginstal library Python Endpoints Frameworks terlebih dahulu. Kemudian, Anda menggunakan alat dari library Endpoints Frameworks untuk membuat dokumen OpenAPI untuk contoh API. Anda memerlukan library Endpoints Frameworks dan dokumen OpenAPI agar Endpoints dapat mengelola API. Untuk mengetahui informasi selengkapnya, lihat Menambahkan pengelolaan API.

Menginstal library Endpoints Frameworks

Bagian ini akan memandu Anda menggunakan pip Python untuk menambahkan library Endpoints Frameworks ke direktori project contoh API.

Untuk menambahkan library Endpoints Frameworks ke contoh:

  1. Pastikan Anda berada di direktori utama sample API, python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo.

  2. Buat subdirektori /lib dalam project:

    mkdir lib

  3. Dari direktori utama contoh python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo, jalankan perintah penginstalan:

    pip install --target lib --requirement requirements.txt --ignore-installed

    Perhatikan hal berikut:

    • Perintah pip ini dapat menggunakan GNU Compiler Collection (GCC) untuk mengompilasi modul ekstensi. Jika Anda menggunakan macOS dan ini adalah pertama kalinya Anda menjalankan GCC di sistem Anda, Anda mungkin harus menyetujui lisensi XCode Apple. Untuk melakukannya, jalankan sudo xcodebuild -license.

    • Jika Anda menginstal beberapa versi Python di komputer, pastikan Anda menggunakan versi pip yang sesuai dengan versi Python yang Anda gunakan dalam tutorial ini. Ketidakcocokan versi (pip dari Python 3.4 saat menggunakan python dari Python 2.7, misalnya) dapat menyebabkan error yang sulit dipahami. Jika perlu, Anda dapat menjalankan pip sebagai modul Python: ganti pip dalam perintah sebelumnya dengan python -m pip.

    • Jika pip tidak dapat menemukan paket yang sesuai saat menjalankan perintah, coba upgrade dengan menjalankan pip install --upgrade pip. Setelah upgrade selesai, coba perintah penginstalan lagi.

    • Pada beberapa rilis Debian dan Ubuntu, pip mungkin gagal dengan DistutilsOptionError. Jika Anda melihat error ini, tambahkan tanda --system.

Setelah berhasil diselesaikan, direktori lib akan diisi dengan file yang diperlukan untuk membangun aplikasi Endpoints Frameworks.

Membuat dokumen OpenAPI

Anda menggunakan alat dari library Endpoints Frameworks untuk membuat dokumen yang menjelaskan REST API contoh kode.

Untuk membuat dokumen OpenAPI:

  1. Pastikan Anda berada di direktori utama contoh:

    python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo

  2. Buat dokumen OpenAPI:

    python lib/endpoints/endpointscfg.py get_openapi_spec main.EchoApi --hostname [YOUR_PROJECT_ID].appspot.com

    Ganti [YOUR_PROJECT_ID] dengan Google Cloud project ID Anda. Abaikan peringatan yang ditampilkan. Alat Endpoints akan membuat dokumen OpenAPI bernama echov1openapi.json di direktori saat ini. Alat Endpoints memberi nama file berdasarkan nama dan versi layanan yang ditentukan dalam dekorator @endpoints.api. Lihat Membuat API untuk mengetahui informasi selengkapnya.

    Endpoints menggunakan teks yang ditentukan dalam argumen hostname sebagai nama layanan. Format nama YOUR_PROJECT_ID.appspot.com cocok dengan entri DNS yang dibuat secara otomatis saat Anda men-deploy API ke backend App Engine. Jadi, dalam hal ini, nama layanan Endpoints dan nama domain yang sepenuhnya memenuhi syarat (FQDN) sama.

Setelah berhasil diselesaikan, pesan berikut akan ditampilkan: OpenAPI spec written to ./echov1openapi.json

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoints, Anda menggunakan Service Infrastructure, platform layanan dasar Google, yang digunakan oleh Endpoints dan layanan lain untuk membuat dan mengelola API serta layanan.

Untuk men-deploy file konfigurasi:

  1. Pastikan Anda berada di direktori utama contoh: 
    python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
  2. Deploy dokumen OpenAPI yang dibuat di bagian sebelumnya dengan menjalankan perintah berikut: 
    gcloud endpoints services deploy echov1openapi.json

    Tindakan ini akan membuat layanan Endpoints baru dengan nama yang Anda tentukan dalam argumen hostname saat Anda menjalankan alat Endpoints untuk membuat dokumen OpenAPI. Apa pun nama layanan Endpoints, saat Anda men-deploy API di App Engine, data DNS dibuat menggunakan format nama YOUR_PROJECT_ID.appspot.com, yang merupakan FQDN yang Anda gunakan saat mengirim permintaan ke API.

    Saat membuat dan mengonfigurasi layanan, Service Management akan menampilkan banyak informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur di echov1openapi.json yang tidak memerlukan kunci API dengan aman. Saat deployment selesai, pesan yang mirip dengan berikut akan ditampilkan:

    Service Configuration [2017-02-13r2] uploaded for service [example-project-12345.appspot.com]

    Dalam contoh sebelumnya, 2017-02-13-r2 adalah ID konfigurasi layanan dan example-project-12345.appspot.com adalah nama layanan.

    Lihat gcloud endpoints services deploy di dokumentasi referensi gcloud untuk mengetahui informasi selengkapnya.

Memeriksa layanan yang diperlukan

Untuk menyediakan pengelolaan API, Endpoints Frameworks memerlukan layanan berikut:
Nama Judul
servicemanagement.googleapis.com Service Management API
servicecontrol.googleapis.com Service Control API

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy akan mengaktifkan layanan yang diperlukan ini. Namun, perintah gcloud berhasil diselesaikan, tetapi tidak mengaktifkan layanan yang diperlukan dalam keadaan berikut:

  • Jika Anda menggunakan aplikasi pihak ketiga seperti Terraform, dan Anda tidak menyertakan layanan ini.

  • Anda men-deploy konfigurasi Endpoints ke projectGoogle Cloud yang sudah ada tempat layanan ini dinonaktifkan secara eksplisit.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan sudah diaktifkan:

gcloud services list

Jika Anda tidak melihat layanan yang diperlukan tercantum, aktifkan layanan tersebut:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Aktifkan juga layanan Endpoints Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

  • Setelah men-deploy konfigurasi Endpoints, buka halaman Endpoints di Konsol Cloud. Daftar ENDPOINTS_SERVICE_NAME yang mungkin ditampilkan di kolom Nama layanan.

  • Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom host spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom name konfigurasi gRPC Endpoints.

Untuk mengetahui informasi selengkapnya tentang perintah gcloud, lihat layanan gcloud.

Menjalankan contoh secara lokal

Setelah men-deploy konfigurasi Endpoints, Anda dapat menjalankan contoh secara lokal menggunakan Server pengembangan lokal.

  1. Pastikan Anda berada di direktori utama contoh:

    python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo

  2. Mulai server pengembangan lokal:

    dev_appserver.py ./app.yaml

    Secara default, server pengembangan memproses http://localhost:8080, seperti yang ditunjukkan dalam log konsol Google Cloud yang dicetak oleh dev_appserver.py:

    INFO 2018-01-01 [...] Starting module "default" running at: http://localhost:8080

  3. Kirim permintaan ke server pengembangan lokal:

Linux atau Mac OS

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    http://localhost:8080/_ah/api/echo/v1/echo

Pada curl sebelumnya:

  • Opsi --data menentukan data yang akan diposting ke API.
  • Opsi --header menentukan bahwa data dalam format JSON.

PowerShell

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://localhost:8080/_ah/api/echo/v1/echo").Content

Pada contoh sebelumnya, dua baris pertama diakhiri dengan tanda petik terbalik. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik terbalik. Untuk mengetahui informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

API akan mengembalikan pesan yang Anda kirimkan, dan merespons dengan berikut ini:

{
 "message": "hello world"
}

Men-deploy backend API

Sejauh ini Anda telah men-deploy dokumen OpenAPI ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini memandu Anda men-deploy contoh API ke App Engine.

Untuk men-deploy backend API:

  1. Tampilkan ID konfigurasi layanan dengan menjalankan perintah berikut:

    gcloud endpoints configs list --service=[YOUR_PROJECT_ID].appspot.com

    Ganti [YOUR_PROJECT_ID] dengan project ID Anda. Contoh:

    gcloud endpoints configs list --service=example-project-12345.appspot.com
  2. Open the app.yaml file in the python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo directory. 
    env_variables:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy swagger.json' command.
  ENDPOINTS_SERVICE_NAME: YOUR-PROJECT-ID.appspot.com
  ENDPOINTS_SERVICE_VERSION: 2016-08-01r0
  • Lakukan perubahan berikut di bagian env_variables:
    • Di kolom ENDPOINTS_SERVICE_NAME, ganti YOUR-PROJECT-ID dengan ID project Google Cloud Anda.
    • Di kolom ENDPOINTS_SERVICE_VERSION, ganti teks dengan ID konfigurasi layanan. Contoh: 
      ENDPOINTS_SERVICE_NAME: example-project-12345.appspot.com
  ENDPOINTS_SERVICE_VERSION: 2017-02-13r2
  • Jalankan perintah berikut: 
    gcloud app deploy
  • Ikuti perintah pada layar. Tunggu beberapa saat hingga deployment berhasil, dan abaikan pesan peringatan. Saat deployment selesai, pesan yang mirip dengan berikut ini akan ditampilkan: 
    File upload done.
Updating service [default]...done.

    Jika Anda menerima pesan error, lihat bagian Pemecahan masalah di dokumentasi App Engine untuk mendapatkan informasi.

    Sebaiknya tunggu beberapa menit sebelum mengirim permintaan ke API Anda saat App Engine diinisialisasi sepenuhnya.

    • Mengirim permintaan ke API contoh

    Linux atau Mac OS

    Kirim permintaan HTTP menggunakan curl. Ganti [YOUR_PROJECT_ID] dengan Google Cloud project ID Anda:

    curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo

    Pada curl sebelumnya:

    • Opsi --data menentukan data yang akan diposting ke API.
    • Opsi --header menentukan bahwa data dalam format JSON.

    PowerShell

    Kirim permintaan HTTP menggunakan Invoke-WebRequest. Ganti [YOUR_PROJECT_ID] dengan Google Cloud project ID Anda:

    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} -URI `
     "https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo").Content

    Pada contoh sebelumnya, dua baris pertama diakhiri dengan tanda petik terbalik. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik terbalik. Untuk mengetahui informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

    Aplikasi pihak ketiga

    Anda dapat menggunakan aplikasi pihak ketiga seperti ekstensi browser Chrome Postman untuk mengirim permintaan:

    • Pilih POST sebagai kata kerja HTTP.
    • Untuk header, pilih kunci content-type dan nilai application/json.
    • Untuk isi, masukkan kode berikut:
      {"message":"hello world"}
    • Masukkan URL ke aplikasi contoh. Contoh:
      https://example-project-12345.appspot.com/_ah/api/echo/v1/echo

    API akan mengembalikan pesan yang Anda kirimkan, dan merespons dengan berikut ini:

    {
 "message": "hello world"
}

    Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

    Melacak aktivitas API

    1. Lihat grafik aktivitas untuk API Anda di konsol Google Cloud di halaman Endpoints > Service.

      Buka halaman Endpoints Services

      Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.

    2. Lihat log permintaan untuk API Anda di halaman Logs Explorer.

      Buka halaman Logs Explorer

    Pembersihan

    Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

    1. In the Google Cloud console, go to the Manage resources page.

      Go to Manage resources

    2. In the project list, select the project that you want to delete, and then click Delete.
    3. In the dialog, type the project ID, and then click Shut down to delete the project.

    Langkah berikutnya