Questa pagina è stata tradotta dall'API Cloud Translation.

Gestisci versioni

Questa pagina si applica ad Apigee e Apigee hybrid.

Questo argomento spiega come creare e gestire le versioni dell'API. Per scoprire di più sulle versioni, consulta 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:

Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API
Fai clic su API.
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 trovare un'API.
Fai clic su un'API per visualizzarne i dettagli.
Nella scheda Versioni, fai clic su Aggiungi versione.
Specifica i dettagli della versione nel modulo Aggiungi una nuova versione. Devi fornire un nome visualizzato. Gli altri attributi sono facoltativi. Per ulteriori informazioni sugli attributi, vedi Gestisci 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 delle specifiche dell'API da associare alla versione. Consulta Aggiungere una specifica dell'API a una versione.
- Link a un deployment: seleziona uno o più deployment da associare all'API.
- Attributi definiti dall'utente: sono attributi che definisci in base alle esigenze della tua organizzazione o del tuo team. Vedi Attributi utente.
Fai clic su Crea.

REST

Per aggiungere una nuova versione utilizzando l'API Crea una versione dell'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 di API Hub. Il progetto host è stato selezionato durante il 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.
VERSION_ID: (Facoltativo) 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 utilizzare qualsiasi il nome che desideri.
DESCRIPTION: (facoltativo) puoi aggiungere una serie di attributi facoltativi per descrivere la versione, includendo una descrizione, il nome di un proprietario, un link documentazione e altro. Questi attributi facoltativi sono elencati e descritti in Definizione della risorsa 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 delle 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:

Nella console Google Cloud, vai alla pagina Hub API.
Vai all'hub API
Fai clic su API.
Individua l'API che vuoi esaminare. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
Seleziona un'API.
Le versioni sono elencate nella tabella Versioni della pagina dei dettagli dell'API.

REST

Per visualizzare tutte le versioni associate a un'API registrata, utilizza la 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 di API Hub. Il progetto host è stato selezionato quando è stato eseguito il provisioning dell'hub API.
HUB_LOCATION: la località del progetto host. La località è stata scelta quando l'API è stato eseguito il provisioning dell'hub.
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"
    }
  ]
}

Visualizza i dettagli della versione dell'API

Questa sezione spiega come ottenere i dettagli di una versione dell'API, tra cui la sua gli attributi, le operazioni, i deployment e i file di specifiche.

Console

Per visualizzare i dettagli della versione nella console:

Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API
Fai clic su API.
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 trovare un'API.
Seleziona un'API.
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 Get API version details:

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 di API Hub. Il progetto host è stato selezionato durante il provisioning dell'hub API.
HUB_LOCATION: la località 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 API associata a una risorsa API.

Console

Quando elimini una versione nell'interfaccia utente, vengono eliminate tutte le specifiche sottostanti associate alla versione (se presenti).

Per eliminare una versione:

Nella console Google Cloud, vai alla pagina Hub API.
Vai all'hub API
Fai clic su API.
Individua l'API che include la versione da eliminare. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco di API. Se necessario, utilizza la Ricerca per trovare un'API.
Seleziona un'API.
Nella tabella Versioni, individua la versione da eliminare.
Nel menu Azioni (sul lato destro della riga contenente la versione), fai clic su Elimina.

REST

Per impostazione predefinita, una versione può essere eliminata solo se vengono eliminate le specifiche sottostanti. Se vuoi eliminare tutte le specifiche di una versione in un solo passaggio, imposta il valore force parametro di query su true nell'API REST di eliminazione.

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 di API Hub. Il progetto host è stato selezionato quando è stato eseguito il provisioning dell'hub API.
API_LOCATION: la località 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.

Per eliminare una versione e tutte le specifiche sottostanti, imposta il parametro di query force su true. Ad esempio:

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?force=true'

Modificare una versione

Console

Per modificare una versione:

Nella console Google Cloud, vai alla pagina dell'hub API.
Vai all'hub API
Fai clic su API.
Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la Ricerca per trovare un'API.
Seleziona un'API.
Nella tabella Versioni, individua la versione da modificare.
Seleziona Modifica dal menu Azioni sul lato destro della riga della versione. Puoi anche accedere alla funzionalità di modifica facendo clic su Modifica versione nella pagina dei dettagli della versione. Per raggiungere pagina dei dettagli, fai clic su una versione nella tabella delle versioni.
Dopo aver apportato le modifiche, fai clic su Salva per salvarle. Per una descrizione attributi modificabili, consulta descrizione delle risorse della 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 di API Hub. Il progetto host è stato selezionato quando è stato eseguito il provisioning dell'hub API.
HUB_LOCATION: la posizione del progetto host. La località è stata scelta quando l'API è stato eseguito il provisioning dell'hub.
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 Patch version.
LIST_OF_ATTRIBUTES: un elenco separato da virgole di nomi di attributi completi. 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"
}