Rimozione della gestione delle API

Se hai aggiunto la gestione delle API alla tua applicazione su Google Cloud e in seguito decidi di non volere le funzionalità di gestione delle API, puoi configurare Cloud Endpoints Frameworks per interrompere la gestione dell'API.

La rimozione della gestione delle API non interrompe la pubblicazione dell'API. Se vuoi interrompere la gestione dell'API, puoi disabilitare l'applicazione nella pagina Impostazioni App Engine nella console Google Cloud oppure eliminare il progetto Google Cloud. Per ulteriori informazioni, consulta Disabilitazione di un'applicazione e arresto di un progetto.

Per rimuovere la gestione delle API:

  1. Esegui il backup dei file web.xml e appengine-web.xml del tuo progetto API.

  2. Nel file web.xml del tuo progetto API, rimuovi quanto segue:

    • Il filtro endpoints-api-configuration.
    • Il filtro endpoints-api-controller.
    • La mappatura dei filtri endpoints-api-configuration.
    • La mappatura dei filtri endpoints-api-controller.

    Dopo aver eliminato i filtri e le mappature dei filtri, web.xml dovrebbe essere simile a questo:

    <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. Nel file appengine-web.xml, rimuovi la riga che definisce la variabile di ambiente ENDPOINTS_SERVICE_NAME. Se ENDPOINTS_SERVICE_NAME è l'unica variabile di ambiente che hai definito, rimuovi l'intera sezione env-variables.

  4. Pulisci il progetto e crea l'API:

    Maven

        mvn clean
    mvn package

    Gradle

        gradle clean
    gradle build

  5. Esegui di nuovo il deployment dell'applicazione:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy

Dopo aver eseguito nuovamente il deployment dell'applicazione, Cloud Endpoints Frameworks smette di gestire l'API.

Verifica della rimozione della gestione dell'API in corso...

Per verificare che Endpoints Frameworks non gestisca più la tua API:

  1. Nella console Google Cloud, vai alla pagina Endpoint > Servizi.

    Vai alla pagina Endpoints Services

  2. Annota il numero di richieste per uno dei metodi dell'API.

  3. Fai clic sul link View logs per il metodo.

  4. Nel log Produced API, prendi nota della data e dell'ora della voce di log più recente.

  5. Invia alcune richieste al metodo nell'API.

  6. Nella console Google Cloud, vai alla pagina Endpoint > Servizi.

    Vai alla pagina Endpoints Services

    Il contatore delle richieste per il metodo non è aggiornato.

  7. Fai clic sul link View logs per il metodo.

    Il log Produced API non contiene voci di log per le richieste che hai inviato.

Rimozione delle dipendenze nella configurazione della build

Sebbene non sia obbligatorio, ti consigliamo di rimuovere le dipendenze nella configurazione della build.

Per rimuovere le dipendenze nella configurazione della build:

  1. Esegui il backup del tuo file pom.xml o di build.gradle.

  2. Rimuovi le seguenti dipendenze:

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

  3. Pulisci il progetto e crea l'API:

    Maven

        mvn clean
    mvn package

    Gradle

        gradle clean
    gradle build

  4. Esegui di nuovo il deployment dell'applicazione:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy

  5. Testa l'API per assicurarti che funzioni come previsto.

Eliminazione del servizio gestito

Endpoints Frameworks utilizza Service Management di Google per gestire l'API. Quando hai eseguito il deployment del documento OpenAPI con il comando gcloud endpoints services deploy, il comando ha utilizzato Service Management per creare un servizio gestito per l'API. Se non hai bisogno dei dati della pagina Endpoint > Servizi e del log API Produced della pagina Visualizzatore log, puoi eliminare il servizio gestito per l'API e rimuovere i dati dalla console Google Cloud.

Per eliminare il servizio gestito:

  1. Assicurati che gcloud CLI (gcloud) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud:

    gcloud auth login

  2. Inserisci quanto segue per visualizzare gli ID dei tuoi progetti Google Cloud:

    gcloud projects list

  3. Utilizzando l'ID progetto applicabile del passaggio precedente, imposta il progetto Google Cloud predefinito su quello in cui si trova la tua applicazione:

    gcloud config set project [YOUR_PROJECT_ID]

  4. Ottieni il nome di tutti i servizi gestiti nel tuo progetto Google Cloud:

    gcloud endpoints services list

  5. Elimina il servizio da Service Management. Sostituisci SERVICE_NAME con il nome del servizio che vuoi rimuovere.

    gcloud endpoints services delete SERVICE_NAME

    L'esecuzione di gcloud endpoints services delete non elimina immediatamente il servizio gestito. Service Management disabilita il servizio gestito per 30 giorni, dandoti la possibilità di ripristinarlo in caso di necessità. Dopo 30 giorni, Service Management elimina definitivamente il servizio gestito.

Passaggi successivi