Men-deploy dan menguji API

Halaman ini menjelaskan cara men-deploy API Anda.

Sebelum memulai

Men-deploy API ke produksi

Untuk men-deploy API:

  1. Tetapkan variabel lingkungan ENDPOINTS_GAE_SDK ke jalur folder App Engine SDK Anda: Path_to_Cloud_SDK/platform/google_appengine.

    Ganti Path_to_Cloud_SDK dengan output perintah berikut:

     gcloud info --format="value(installation.sdk_root)"
    
  2. Jalankan perintah berikut di direktori utama API:

     gcloud app deploy
    

    Tunggu beberapa saat hingga deployment berhasil, dengan mengabaikan pesan peringatan. Setelah deployment selesai, pesan yang mirip dengan pesan berikut akan ditampilkan:

    File upload done.
    Updating service [default]...done.
    
  3. Konfirmasi deployment yang berhasil dengan mengirimkan permintaan pengujian ke API, misalnya:

    curl --request POST \
       --header "Content-Type: application/json" \
       --data '{"content":"echo"}' \
       https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2
    

    Ganti PROJECT_ID dengan project ID Anda dan echo dengan nama API Anda.

    Hasilnya adalah:

    {
     "content": "echo echo"
    }
    

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

Men-deploy ke beberapa versi aplikasi

Untuk mengetahui informasi tentang cara membuat versi API, dan cara men-deploy ke versi, lihat Menangani pembuatan versi API

Menguji API secara lokal

Anda dapat menggunakan server pengembangan lokal App Engine untuk menguji API secara lokal. Untuk informasi selengkapnya tentang server pengembangan lokal, lihat Menggunakan server pengembangan lokal.

Untuk menjalankan API secara lokal:

  1. Dari direktori root project, mulai server pengembangan App Engine:

    dev_appserver.py YOUR_PROJECT_DIR
    
  2. Jalankan curl untuk membuat permintaan API, misalnya:

     curl --request POST \
        --header "Content-Type: application/json" \
        --data '{"message":"echo"}' \
        "${HOST}/_ah/api/echo/v1/echo?n=2"
    

Menambahkan pengelolaan API

Endpoints Framework menyediakan fitur pengelolaan API seperti:

Agar API Anda dikelola oleh Framework Endpoints, Anda harus membuat dan men-deploy dokumen OpenAPI yang mendeskripsikan API Anda, seperti yang dijelaskan dalam Menambahkan pengelolaan API.