Menghapus pengelolaan API

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

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

Untuk menghapus pengelolaan API:

  1. Cadangkan 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 serupa dengan berikut:

    <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, lalu build API:

    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, Framework Cloud Endpoints akan berhenti mengelola API Anda.

Memverifikasi penghapusan pengelolaan API

Untuk memverifikasi bahwa Framework Endpoint tidak lagi mengelola API Anda:

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

    Buka halaman Endpoints Services

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

  3. Klik link View logs untuk metode tersebut.

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

  5. Kirim beberapa permintaan ke metode di API Anda.

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

    Buka halaman Endpoints Services

    Penghitung permintaan untuk metode 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 diperlukan, sebaiknya Anda menghapus dependensi dalam konfigurasi build.

Untuk menghapus dependensi dalam konfigurasi build:

  1. Cadangkan 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, lalu build API:

    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 memastikannya berfungsi seperti yang diharapkan.

Menghapus layanan terkelola

Framework Endpoints 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 tidak memerlukan data di halaman Endpoints > Services dan di log Produced API di halaman Logs Viewer, Anda dapat menghapus layanan terkelola untuk API, yang akan menghapus data dari Konsol Google Cloud.

Untuk menghapus layanan terkelola:

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

    gcloud auth login

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

    gcloud projects list

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

    gcloud config set project [YOUR_PROJECT_ID]

  4. Dapatkan nama semua layanan terkelola di project Google Cloud 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 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 selanjutnya