Men-deploy dan menguji API

Halaman ini menjelaskan cara men-deploy API Anda.

Sebelum memulai

Men-deploy API

Anda dapat men-deploy API menggunakan plugin Apache Maven atau Gradle App Engine. Untuk men-deploy API ke lingkungan standar App Engine produksi, gunakan perintah untuk plugin Anda:

  1. Gunakan perintah untuk plugin Anda:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Tunggu hingga deployment selesai.

  3. Kirim permintaan pengujian ke API yang di-deploy. Misalnya, menggunakan curl:

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    Respons Anda akan mirip dengan berikut ini:

    {
  "message": "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 melakukan pembuatan versi API, dan cara men-deploy ke versi, lihat Menangani pembuatan versi API

Menjalankan dan menguji backend API secara lokal

Untuk menguji API Anda secara lokal:

  1. Bangun project di direktori utama project. Contoh:

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. Mulai server pengembangan App Engine. Contoh:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. Buat permintaan API untuk menguji API Anda. Misalnya, menggunakan curl:

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

Menayangkan API dari jalur yang berbeda

Untuk menayangkan API dari jalur yang berbeda, di file web.xml, ubah url-pattern di bagian EndpointsServlet dan deploy ulang API Anda. Misalnya:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

Menambahkan pengelolaan API

Endpoints Frameworks menyediakan fitur pengelolaan API seperti:

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