Halaman ini menjelaskan cara men-deploy API.
Sebelum memulai
- Siapkan lingkungan pemrograman Anda.
- Buat API dan anotasikan.
Men-deploy API
Anda dapat men-deploy API menggunakan plugin App Engine Apache Maven atau Gradle. Untuk men-deploy API ke lingkungan standar App Engine produksi, gunakan perintah untuk plugin Anda:
- Gunakan perintah untuk plugin Anda:
Maven
mvn appengine:deploy
Gradle
gradle appengineDeploy
- Tunggu hingga deployment selesai.
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"
Tanggapan Anda 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 informasi 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 secara lokal:
Buat project di direktori utama project. Contoh:
Maven
mvn clean package
Gradle
gradle clean build
Mulai server pengembangan App Engine. Contoh:
Maven
mvn appengine:run
Gradle
gradle appengineRun
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"
Menyajikan API Anda dari jalur yang berbeda
Untuk menyalurkan API dari jalur yang berbeda, pada file web.xml
, ubah
url-pattern
di bagian EndpointsServlet
lalu 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 dapat dikelola oleh Framework Endpoint, Anda harus membuat dan men-deploy dokumen OpenAPI yang mendeskripsikan API Anda, seperti yang dijelaskan dalam Menambahkan pengelolaan API.