Menghapus pengelolaan API

Jika Anda menambahkan pengelolaan API ke aplikasi Anda di Google Cloud, dan selanjutnya memutuskan bahwa Anda tidak menginginkan fitur pengelolaan API, Anda dapat mengonfigurasi Cloud Endpoints Frameworks untuk berhenti mengelola API Anda.

Menghapus pengelolaan API tidak akan menghentikan API Anda untuk ditayangkan. Jika ingin berhenti menayangkan API, Anda dapat menonaktifkan aplikasi di halaman App Engine Settings di Google Cloud konsol, atau Anda dapat menghapus Google Cloud project. Lihat Menonaktifkan aplikasi dan menghentikan project untuk mengetahui informasi selengkapnya.

Untuk menghapus pengelolaan API:

  1. Buat cadangan file web.xml dan appengine-web.xml project API Anda.

  2. Di file web.xml project API Anda, hapus hal berikut:

    • Filter endpoints-api-configuration.
    • Filter endpoints-api-controller.
    • Pemetaan filter endpoints-api-configuration.
    • Pemetaan filter endpoints-api-controller.

    Setelah menghapus filter dan pemetaan filter, web.xml Anda akan terlihat mirip dengan berikut ini:

    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    <!-- Wrap the backend with Endpoints Frameworks v2. -->
    <servlet>
        <servlet-name>EndpointsServlet</servlet-name>
        <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
        <init-param>
            <param-name>services</param-name>
            <param-value>com.example.skeleton.MyApi</param-value>
        </init-param>
    </servlet>
    <!-- Route API method requests to the backend. -->
    <servlet-mapping>
        <servlet-name>EndpointsServlet</servlet-name>
        <url-pattern>/_ah/api/*</url-pattern>
    </servlet-mapping>
</web-app>

  3. Di file appengine-web.xml, hapus baris yang menentukan variabel lingkungan ENDPOINTS_SERVICE_NAME. Jika ENDPOINTS_SERVICE_NAME adalah satu-satunya variabel lingkungan yang telah Anda tentukan, hapus seluruh bagian env-variables.

  4. Bersihkan project Anda, lalu build API Anda:

    Maven

        mvn clean
    mvn package

    Gradle

        gradle clean
    gradle build

  5. Deploy ulang aplikasi Anda:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy

Setelah Anda men-deploy ulang aplikasi, Cloud Endpoints Frameworks akan berhenti mengelola API Anda.

Memverifikasi penghapusan pengelolaan API

Untuk memverifikasi bahwa Endpoints Frameworks tidak lagi mengelola API Anda:

  1. Di Google Cloud konsol, buka halaman Endpoints > Services.

    Buka halaman Layanan Endpoints

  2. Tuliskan jumlah permintaan ke salah satu metode di API Anda.

  3. Klik link View logs untuk metode tersebut.

  4. Di log Produced API, tuliskan tanggal dan waktu entri log terbaru.

  5. Kirim beberapa permintaan ke metode di API Anda.

  6. Di Google Cloud konsol, buka halaman Endpoints > Services.

    Buka halaman Layanan Endpoints

    Penghitung permintaan untuk metode tersebut tidak diperbarui.

  7. Klik link View logs untuk metode tersebut.

    Log Produced API tidak berisi entri log untuk permintaan yang Anda kirim.

Menghapus dependensi dalam konfigurasi build

Meskipun tidak wajib, Anda mungkin ingin menghapus dependensi dalam konfigurasi build.

Untuk menghapus dependensi dalam konfigurasi build:

  1. Buat cadangan file pom.xml atau file build.gradle Anda.

  2. Hapus dependensi berikut:

    • endpoints-management-control-appengine
    • endpoints-management-control-appengine-all
    • endpoints-framework-auth

  3. Bersihkan project Anda, lalu build API Anda:

    Maven

        mvn clean
    mvn package

    Gradle

        gradle clean
    gradle build

  4. Deploy ulang aplikasi Anda:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy

  5. Uji API Anda untuk memastikan API berfungsi seperti yang diharapkan.

Menghapus layanan terkelola

Endpoints Frameworks menggunakan Pengelolaan Layanan Google untuk mengelola API Anda. Saat Anda men-deploy dokumen OpenAPI menggunakan perintah gcloud endpoints services deploy, perintah tersebut menggunakan Pengelolaan Layanan untuk membuat layanan terkelola untuk API Anda. Jika Anda tidak memerlukan data di halaman Endpoints > Services dan di log Produced API di halaman Logs Viewer, Anda dapat menghapus layanan terkelola untuk API Anda, yang akan menghapus data dari konsol Google Cloud .

Untuk menghapus layanan terkelola:

  1. Pastikan gcloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud:

    gcloud auth login

  2. Masukkan perintah berikut untuk menampilkan ID project untuk project Google Cloud Anda:

    gcloud projects list

  3. Dengan menggunakan project ID yang berlaku dari langkah sebelumnya, tetapkan project default Google Cloud ke project tempat aplikasi Anda berada:

    gcloud config set project [YOUR_PROJECT_ID]

  4. Dapatkan nama semua layanan terkelola di Google Cloud project Anda:

    gcloud endpoints services list

  5. Hapus layanan dari Pengelolaan Layanan. Ganti SERVICE_NAME dengan nama layanan yang ingin Anda hapus.

    gcloud endpoints services delete SERVICE_NAME

    Menjalankan gcloud endpoints services delete tidak akan langsung menghapus layanan terkelola. Pengelolaan Layanan menonaktifkan layanan terkelola selama 30 hari, sehingga Anda memiliki waktu untuk memulihkannya jika diperlukan. Setelah 30 hari, Pengelolaan Layanan akan menghapus layanan terkelola secara permanen.

Langkah berikutnya