Gestisci versioni

Questa pagina si applica ad Apigee e Apigee hybrid.

Anteprima - Apigee API hub

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Questo argomento spiega come creare e gestire le versioni API. Per saperne di più sulle versioni, consulta la Panoramica delle versioni.

Aggiungi una versione a un'API

Puoi aggiungere una versione API a un'API esistente nella console o con l'API REST.

Console

Per aggiungere una nuova versione:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Individua l'API di cui vuoi eseguire la versione. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
4. Fai clic su un'API per visualizzarne i dettagli.
5. Nella scheda Versioni, fai clic su Aggiungi versione.
6. Specifica i dettagli della versione nel modulo Aggiungi una nuova versione. Devi fornire un nome visualizzato. Gli altri attributi sono facoltativi. Per maggiori informazioni sugli attributi, consulta Gestire gli attributi.
   • Nome : (obbligatorio). Devi fornire un nome visualizzato.
   • Descrizione: aggiungi una descrizione della versione.
   • Ciclo di vita: seleziona la fase del ciclo di vita dell'API.
   • Conformità: seleziona un attributo di conformità.
   • Accreditazione: seleziona un attributo di accreditamento.
   • Documentazione: inserisci l'URL della documentazione per l'API.
   • Aggiungi un file delle specifiche: importa un file di specifiche dell'API da associare alla versione. Consulta l'articolo Aggiungere le specifiche di un'API a una versione.
   • Collega a un deployment: seleziona uno o più deployment da associare all'API.
   • Attributi definiti dall'utente: gli attributi definiti dall'utente sono attributi che definisci in base alle esigenze dell'organizzazione o del team. Consulta Attributi utente.
7. Fai clic su Crea.

REST

Per aggiungere una nuova versione utilizzando l'API Crea una versione API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions?version_id=VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME,
    "description": "DESCRIPTION"               # description is an optional attribute
    }'

Sostituisci quanto segue:

• HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
• HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
• API_ID: l'ID univoco della risorsa API a cui aggiungere la versione.
• (Facoltativo) VERSION_ID: l'identificatore univoco della versione dell'API. Se non viene fornito, verrà utilizzato un ID generato dal sistema. Il nome deve essere una stringa di 4-63 caratteri, dove i caratteri validi sono /[a-z][0-9]-/.
• DISPLAY_NAME: (obbligatorio) il nome visualizzato della versione. Puoi usare il nome che preferisci.
• DESCRIPTION: (facoltativo) puoi aggiungere una serie di attributi facoltativi per descrivere la versione, tra cui una descrizione, il nome di un proprietario, un link alla documentazione e altro ancora. Questi attributi facoltativi sono elencati e descritti nella Definizione delle risorse di versione.

Esempio di output:

{
  "name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
  "displayName": "My Version 1",
  "createTime": "2024-04-02T18:48:41.162360Z",
  "updateTime": "2024-04-02T18:48:41.162360Z"
}

Elenco versioni API

Questa sezione spiega come elencare le versioni associate a un'API registrata.

Console

Per visualizzare tutte le versioni associate a un'API registrata nella console:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Individua l'API che vuoi ispezionare. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
4. Seleziona un'API.
5. Le versioni sono elencate nella tabella Versioni nella pagina dei dettagli dell'API.

REST

Per visualizzare tutte le versioni associate a un'API registrata, utilizza l'API List API Version:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Sostituisci quanto segue:

• HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
• HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
• API_ID: l'ID univoco della risorsa API.

Esempio di output:

{
  "versions": [
    {
      "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
      "displayName": "Streetcarts Test v1"
    }
  ]
}

Ottieni dettagli versione API

Questa sezione spiega come ottenere i dettagli di una versione dell'API, inclusi attributi, operazioni, deployment e file delle specifiche.

Console

Per visualizzare i dettagli della versione nella console:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Individua l'API che vuoi ispezionare. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
4. Seleziona un'API.
5. Nella tabella Versioni, fai clic su una versione per visualizzare la pagina dei dettagli della versione.

REST

Per visualizzare i dettagli di una versione utilizzando l'API Ottieni dettagli versione API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Sostituisci quanto segue:

• HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
• HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
• API_ID: l'ID univoco della risorsa API.
• VERSION_ID: l'ID univoco della versione.

Esempio di output:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1",
  "displayName": "Test Version 3",
  "documentation": {},
  "specs": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/specs/docs-spec-1"
  ],
  "apiOperations": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/listpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/createpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/deletepet",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/getpetbyid",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/updatepet"
  ],
  "definitions": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/definitions/pet"
  ],
  "createTime": "2024-04-04T14:53:57.299213423Z",
  "updateTime": "2024-04-04T14:53:58.027321138Z"
}

Elimina una versione API

Questa sezione spiega come eliminare una versione dell'API associata a una risorsa API. Puoi eliminare una versione solo se vengono eliminati prima tutte le specifiche, le operazioni, le definizioni e i deployment collegati sottostanti.

Console

Per eliminare una versione:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Individua l'API che include la versione da eliminare. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
4. Seleziona un'API.
5. Nella tabella Versioni, individua la versione da eliminare.
6. Dal menu Azioni (sul lato destro della riga contenente la versione), fai clic su Elimina.

REST

Per eliminare una versione utilizzando l'API Delete API version:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID'

Sostituisci quanto segue:

• API_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
• API_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
• API_ID: l'ID univoco della risorsa API.
• VERSION_ID: l'ID della versione da eliminare.

Modifica una versione

Console

Per modificare una versione:

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
4. Seleziona un'API.
5. Nella tabella Versioni, individua la versione da modificare.
6. Seleziona Modifica dal menu Azioni sul lato destro della riga della versione. Puoi accedere alla funzionalità di modifica anche facendo clic su Modifica versione nella pagina dei dettagli della versione. Per accedere alla pagina dei dettagli, fai clic su una versione nella tabella delle versioni.
7. Dopo aver apportato le modifiche, fai clic su Salva per salvarle. Per una descrizione degli attributi modificabili, consulta la descrizione della risorsa di versione nel riferimento dell'API REST.

REST

Per modificare una versione con l'API REST:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
    '{
      "display-name": DISPLAY_NAME,  # Use the request body to specify attribute changes
      "description": "DESCRIPTION"

    }'

Sostituisci quanto segue:

• HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
• HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
• API_ID: l'ID univoco dell'API contenente la versione che vuoi modificare.
• VERSION_ID: l'ID della versione da modificare.
• DESCRIPTION: puoi aggiungere altri attributi modificabili nel corpo della richiesta, come la descrizione e altri. Gli attributi modificabili sono elencati nel riferimento dell'API Apigee Hub. l'API della versione Patch.
• LIST_OF_ATTRIBUTES: un elenco separato da virgole di nomi completi degli attributi. Ad esempio: ?updateMask="description".

Esempio di output:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
  "displayName": "Streetcarts Test v1",
  "description": "This is a revision of the test version.",
  "documentation": {},
  "createTime": "2024-04-18T19:57:11.870761Z",
  "updateTime": "2024-04-18T20:23:42.465324Z"
}